华为云用户手册

  • URI DELETE https://localhost.com/v1/workspaces/{workspace_id}/models/{model_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释:工作空间ID。获取方法,请参见获取工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 model_id 是 String 参数解释:推理模型ID。获取方法,请参见获取模型ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码: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]个字符。 默认取值:不涉及。 状态码:404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • 请求示例 请求过滤tag_key的标签的资源,具体请求实例如下。 POST https://{endpoint}/v1/{project_id}/fabric-workspace/resource-instances/filter { "without_any_tag" : false, "tags" : [ { "key" : "tag_key", "values" : [ "tag_value" ] } ], "matches" : [ { "key" : "resource_name", "value" : "tag_value" } ], "sys_tags" : "" }
  • 响应示例 状态码:200 OK { "resources" : [ { "resource_id" : "01049549-82cd-4b2b-9733-ddb94350c125", "resource_detail" : { }, "resource_name" : "resource_name", "tags" : [ { "key" : "key1", "value" : "value1" } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "01049549-82cd-4b2b-9733-ddb94350c125" } ] } ], "total_count" : 1 } 状态码: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 表8 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释:请求ID。 约束限制:不可修改。 取值范围:不涉及。 默认取值:不涉及。 表9 响应Body参数 参数 参数类型 描述 resources Array of TagFabricWorkspace objects 参数解释:资源列表。 约束限制:不涉及。 取值范围:[0,1000]。 默认取值:不涉及。 total_count Integer 参数解释:资源总数。 约束限制:不涉及。 取值范围:[0,1000]。 默认取值:不涉及。 表10 TagFabricWorkspace 参数 参数类型 描述 resource_id String 参数解释:工作空间的ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 resource_detail Object 参数解释:资源详情。 资源对象,用于扩展。默认为空。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 resource_name String 参数解释:工作空间名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 tags Array of ResourceTag objects 参数解释:标签列表,没有标签默认为空数组。 约束限制:不涉及。 取值范围:[0,100000]。 默认取值:不涉及。 sys_tags Array of SystemTag objects 参数解释:系统标签。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表11 ResourceTag 参数 参数类型 描述 key String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 value String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 表12 SystemTag 参数 参数类型 描述 key String 参数解释:键。 约束限制:固定值。 取值范围:不涉及。 默认取值:不涉及。 value String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 状态码:400 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:401 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表15 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • URI POST https://localhost.com/v1/{project_id}/fabric-workspace/resource-instances/filter 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:[0,1000000000]。 默认取值:0。 limit 否 Integer 参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:[1,100]。 默认取值:10。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。用于调用接口的认证。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 表4 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 参数解释:不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 约束限制:不涉及。 取值范围:true,false。 默认取值:不涉及。 tags 否 Array of ResourceTagParam objects 参数解释:包含标签,最多包含50个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。 约束限制:不涉及。 取值范围:[1,20]。 默认取值:不涉及。 matches 否 Array of TagMatch objects 参数解释:搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。 约束限制:不涉及。 取值范围:[1,10]。 默认取值:不涉及。 sys_tags 否 Array of SystemTagParam objects 参数解释:系统标签列表,目前只包含一个tag结构体。key下面只包含一个value。 约束限制:不涉及。 取值范围:1。 默认取值:不涉及。 表5 ResourceTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 values 否 Array of strings 参数解释:资源标签的值列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表6 TagMatch 参数 是否必选 参数类型 描述 key 是 String 参数解释:键。 约束限制:不涉及。 取值范围:resource_name。 默认取值:resource_name。 value 否 String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表7 SystemTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释:键。 约束限制:固定值。 取值范围:不涉及。 默认取值:不涉及。 values 是 Array of strings 参数解释:系统标签的值列表。 约束限制:固定值。 取值范围:1。 默认取值:不涉及。
  • URI POST https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id}/invocations 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释:工作空间的ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。 instance_id 是 String 参数解释:实例的ID。获取方法,请参见获取推理实例ID。 约束限制:不涉及。 取值范围:长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值:不涉及。
  • 请求示例 调用已部署的大模型推理实例,发起推理请求。具体请求参数如下实例所示。 POST https://{endpoint}/v1/workspaces/{workspace_id}/services/instances/{instance_id}/invocations { "messages" : [ { "role" : "user", "content" : "请总结2023年LLM的发展" } ] }
  • 响应参数 状态码:200 创建ChatCompletions的响应体。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 状态码:403 Forbidden 状态码:404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 状态码:408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度[8,36]。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度[2,4096]。 默认取值:不涉及。
  • 响应示例 状态码:200 创建ChatCompletions的响应体。 { "route_id" : "ac8111bf-3601-4905-8ddd-b41d3e636a4e" } 状态码: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" } 状态码:404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 响应示例 状态码: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" } 状态码:404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • URI POST https://localhost.com/v1/workspaces/{workspace_id}/endpoints/{endpoint_id}/subscribe 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释:工作空间ID,获取方法,请参见获取工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 endpoint_id 是 String 参数解释:端点ID。获取方法,请参见获取端点ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码: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]个字符。 默认取值:不涉及。 状态码:404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • 响应示例 状态码:200 查询工作空间列表响应体。 { "total" : 2, "workspaces" : [ { "id" : "90a827a1-ca72-4be8-943b-774f94xxxxxx", "name" : "workspace1SqlResourceDef", "create_time" : "2025-01-10T03:37:12.000+00:00", "create_domain_name" : "create_domain_name_001", "create_user_name" : "create_user_name_001", "enterprise_project_id" : 0 }, { "id" : "90a827a1-ca72-4be8-943b-774f95xxxxxx", "name" : "workspace2", "create_time" : "2025-01-11T03:37:12.000+00:00", "create_domain_name" : "create_domain_name_002", "create_user_name" : "create_user_name_002", "enterprise_project_id" : 0 } ] } 状态码: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" } 状态码:404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释:Workspace总数。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 workspaces Array of Workspace objects 参数解释:Workspace列表。 约束限制:不涉及。 取值范围:[0,1000]。 默认取值:不涉及。 表4 Workspace 参数 参数类型 描述 id String 参数解释:工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 name String 参数解释:工作空间名称。 约束限制:不涉及。 取值范围:长度为[4,32]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 description String 参数解释:用户输入的描述。 约束限制:不涉及。 取值范围:长度为[0,255]个字符。 默认取值:不涉及。 create_time String 参数解释:创建时间。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 create_domain_name String 参数解释:创建账号名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 create_user_name String 参数解释:创建用户名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 metastore_id String 参数解释:LakeFormation服务的实例ID,即MetaStoreID。 约束限制:不涉及。 取值范围:长度为[32,36]的字母、数字、中划线(-)组合。 默认取值:不涉及。 access_url String 参数解释:访问资源地址。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 enterprise_project_id String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:只有对接了企业项目才可以填写。 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值:0,即default。 tags Array of ResourceTag objects 参数解释:工作空间的资源标签。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表5 ResourceTag 参数 参数类型 描述 key String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 value String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • URI GET https://localhost.com/v1/workspaces 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:[0,1000000000]。 默认取值:0。 limit 否 Integer 参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:[1,100]。 默认取值:10。 name 否 String 参数解释:工作空间名称。 约束限制:不涉及。 取值范围:长度为[4,32]的字母、数字、中划线(-)和下划线(_)的组合。 默认取值:不涉及。 id 否 String 参数解释:工作空间ID,获取方法,请参见获取工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 enterprise_project_id 是 String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:长度为[1,36]的英文字符、数字、中划线(-)和下划线(_)的组合。 取值范围:不涉及。 默认取值:all_granted_eps。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释:请求ID。 约束限制:不可修改。 取值范围:不涉及。 默认取值:不涉及。 表5 响应Body参数 参数 参数类型 描述 tags Array of ResourceTagParam objects 参数解释:标签列表。 约束限制:不涉及。 取值范围:[0,100000]。 默认取值:不涉及。 表6 ResourceTagParam 参数 参数类型 描述 key String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 values Array of strings 参数解释:资源标签的值列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • 响应示例 状态码:200 OK { "tags" : [ { "key" : "tag_key", "values" : [ "tag_value" ] } ] } 状态码: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" }
  • URI GET https://localhost.com/v1/{project_id}/fabric-workspace/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 use_predefine_tags 是 Boolean 参数解释:使用预定义标签。 约束限制:不涉及。 取值范围:true表示使用,false表示不使用。 默认取值:false。 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:[0,1000000000]。 默认取值:0。 limit 否 Integer 参数解释:查询记录数。 约束限制:不涉及。 取值范围:[1,1000]。 默认取值:1000。
  • 响应示例 状态码:200 创建工作空间列表响应体。 { "id" : "90a827a1-ca72-4be8-943b-774f94xxxxxx", "name" : "workspace1", "description" : "workspace1-description", "create_time" : "2025-01-10T03:37:12.000+00:00", "create_domain_name" : "create_domain_name_001", "create_user_name" : "create_user_name_001", "metastore_id" : "2180518f-42b8-4947-b20b-adfc539xxxxx", "access_url" : "https://:test.fabric.com/", "enterprise_project_id" : 0 } 状态码: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" } 状态码:404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 请求示例 创建工作空间。其名称为fabric,描述为fabric-description,对应的MetastoreID为xxxxxx,对应企业项目ID为01049549-82cd-4b2b-9733-ddb94350c125,对应标签有key1,值为value1,key2,值为value2。 POST https://{endpoint}/v1/workspaces { "name" : "fabric", "description" : "fabric-description", "metastore_id" : "xxxxxx", "enterprise_project_id" : "01049549-82cd-4b2b-9733-ddb94350c125", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。用于调用接口的认证。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释:工作空间名称。 约束限制:不涉及。 取值范围:长度为[4,32]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 description 否 String 参数解释:用户输入的描述。 约束限制:不涉及。 取值范围:长度为[0,255]个字符。 默认取值:不涉及。 metastore_id 否 String 参数解释:LakeFormation服务的实例ID,即MetaStoreID。 约束限制:不涉及。 取值范围:长度为[32,36]的字母、数字、中划线(-)组合。 默认取值:不涉及。 enterprise_project_id 否 String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:只有对接了企业项目才可以填写。 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值:0,即default。 tags 否 Array of ResourceTag objects 参数解释:资源标签。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表3 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 value 否 String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 id String 参数解释:工作空间ID。 约束限制:不涉及。 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 name String 参数解释:工作空间名称。 约束限制:不涉及。 取值范围:长度为[4,32]的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 description String 参数解释:用户输入的描述。 约束限制:不涉及。 取值范围:长度为[0,255]个字符。 默认取值:不涉及。 create_time String 参数解释:创建时间。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 create_domain_name String 参数解释:创建账号名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 create_user_name String 参数解释:创建用户名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 metastore_id String 参数解释:LakeFormation服务的实例ID,即MetaStoreID。 约束限制:不涉及。 取值范围:长度为[32,36]的字母、数字、中划线(-)组合。 默认取值:不涉及。 access_url String 参数解释:访问资源地址。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 enterprise_project_id String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:只有对接了企业项目才可以填写。 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值:0,即default。 tags Array of ResourceTag objects 参数解释:工作空间的资源标签。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表5 ResourceTag 参数 参数类型 描述 key String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 value String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • 响应示例 状态码:200 OK { "policy_types" : [ "FABRIC_LAKEFORMATION_POLICY" ] } 状态码: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" } 状态码:404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码: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]个字符。 默认取值:不涉及。 状态码:404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:不涉及。 取值范围:长度为[8,36]个字符。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:不涉及。 取值范围:长度为[2,512]个字符。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:不涉及。 取值范围:长度为[0,4096]个字符。 默认取值:不涉及。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。用于调用接口的认证。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 表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:镜像包注册功能相关权限策略。 FABRIC_LTS_POLICY:日志功能相关权限策略。 FABRIC_VPCEP_POLICY:网络打通功能相关权限策略。 FABRIC_DNS_POLICY:DNS相关权限策略。 默认取值:不涉及。
  • 响应示例 状态码: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" }
  • 请求示例 创建端点。具体规格如样例展示。 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" } ] }
  • 响应参数 状态码: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]个字符。 默认取值:不涉及。
共100000条
提示

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