华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释：符合条件的总数。 约束限制：不涉及。 取值范围：[0,10000]。 默认取值：不涉及。 models Array of BaseModel objects 参数解释：列表信息。 约束限制：不涉及。 取值范围：[0,1000]。 默认取值：不涉及。 表4 BaseModel 参数 参数类型 描述 base_model_type String 参数解释：基模型类型。请从ListBaseModels列举基模型接口响应中获取。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 max_tokens Integer 参数解释：支持的最大Token数。 约束限制：不涉及。 取值范围：最小值1。 默认取值：不涉及。 num_of_mu Integer 参数解释：消耗MU数量。 约束限制：不涉及。 取值范围：[1,128]。 默认取值：不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

响应示例 状态码：200 更新工作空间列表响应体。 { "id" : "exxxx0ef-f4eb-4b95-aff1-9d33ae9fxxxx", "name" : "fabric", "description" : "fabric-description", "create_time" : "2023-05-30T12:24:30.401Z", "create_domain_name" : "domain_name", "create_user_name" : "user_name", "metastore_id" : "2xxx518f-42b8-4947-b20b-adfcxxx81a2x", "access_url" : "https://:test.fabric.com/", "enterprise_project_id" : "01049549-82cd-4b2b-9733-ddb9435xxxxx" } 状态码：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。 PUT https://{endpoint}/v1/workspaces/{workspace_id} { "name" : "fabric", "description" : "fabric-description", "metastore_id" : "xxxxxx" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表3 请求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。

响应参数 状态码：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 { "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" } 状态码：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" }

请求示例 请求统计tag_key的标签的资源，具体请求实例如下。 POST https://{endpoint}/v1/{project_id}/fabric-workspace/resource-instances/count { "without_any_tag" : false, "tags" : [ { "key" : "tag_key", "values" : [ "tag_value" ] } ], "matches" : [ { "key" : "resource_name", "value" : "tag_value" } ], "sys_tags" : "" }

响应参数 状态码：200 表7 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释：请求ID，定位辅助信息。 约束限制：不可修改。 取值范围：不涉及。 默认取值：不涉及。 表8 响应Body参数 参数 参数类型 描述 total_count Integer 实例总数。 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表13 响应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/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目ID。获取方法，请参见获取项目ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表3 请求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。 默认取值：不涉及。 表4 ResourceTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释：资源标签的键。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 values 否 Array of strings 参数解释：资源标签的值列表。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表5 TagMatch 参数 是否必选 参数类型 描述 key 是 String 参数解释：键。 约束限制：不涉及。 取值范围：resource_name。 默认取值：resource_name。 value 否 String 参数解释：资源标签的值。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表6 SystemTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释：键。 约束限制：固定值。 取值范围：不涉及。 默认取值：不涉及。 values 是 Array of strings 参数解释：系统标签的值列表。 约束限制：固定值。 取值范围：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" } 状态码：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 表3 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：404 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释：请求ID。 约束限制：不可修改。 取值范围：不涉及。 默认取值：不涉及。 表5 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects 参数解释：资源标签列表。 约束限制：不涉及。 取值范围：[0,100000]。 默认取值：不涉及。 sys_tags Array of SystemTag objects 参数解释：系统标签列表。 约束限制：不涉及。 取值范围：[0,1]。 默认取值：不涉及。 表6 ResourceTag 参数 参数类型 描述 key String 参数解释：资源标签的键。 约束限制：不涉及。 取值范围：长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值：不涉及。 value String 参数解释：资源标签的值。 约束限制：不涉及。 取值范围：长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值：不涉及。 表7 SystemTag 参数 参数类型 描述 key String 参数解释：键。 约束限制：固定值。 取值范围：不涉及。 默认取值：不涉及。 value String 参数解释：企业项目ID。获取方法，请参见获取企业项目ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

响应示例 状态码：200 OK { "tags" : [ { "key" : "key1", "value" : "value1" } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "01049549-82cd-4b2b-9733-ddb94350c125" } ] } 状态码：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/{workspace_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目ID。获取方法，请参见获取项目ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 workspace_id 是 String 参数解释：工作空间ID，获取方法，请参见获取工作空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 limit 否 Integer 参数解释：查询记录数。 约束限制：不涉及。 取值范围：[1,1000]。 默认取值：1000。

请求示例 更新模型。名称为LLama3-8b，描述为description，当前版本ID为0b5633ba2b904511ad514346f4d23d4b，生成新版本配置如下样例所示。 PUT https://{endpoint}/v1/workspaces/{workspace_id}/models/{model_id} { "name" : "LLama3-8b", "description" : "description", "current_version_id" : "0b5633ba2b904511ad514346f4d23d4b", "version" : { "name" : "name", "description" : "description", "config" : { "llm_model_config" : { "base_model_type" : "string", "model_path" : "obs://bucketname/objectdir/modelpath/" } } } }

响应示例 状态码：200 OK。 { "visibility" : "PRIVATE", "id" : "0b5633ba2b904511ad514346f4d23d4b", "name" : "LLama3-8b", "description" : "description", "type" : "LLM_MODEL", "create_time" : "2023-05-30T12:24:30.401Z", "update_time" : "2023-05-30T12:24:30.401Z", "current_version" : { "id" : "0b5633ba2b904511ad514346f4d23d4b", "name" : "name", "cap_white_list" : [ "cap1 cap2 ca* cap*" ], "description" : "description", "config" : { "llm_model_config" : { "base_model_type" : "string", "model_path" : "obs://bucketname/objectdir/modelpath/" } }, "create_time" : "2023-05-30T12:24:30.401Z", "create_user" : { "domain_name" : "string", "domain_id" : "0b5633ba2b904511ad514346f4d23d4b", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4d23d4b" } }, "create_user" : { "domain_name" : "string", "domain_id" : "0b5633ba2b904511ad514346f4d23d4b", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4d23d4b" }, "update_user" : { "domain_name" : "string", "domain_id" : "0b5633ba2b904511ad514346f4d23d4b", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4d23d4b" }, "new_version" : { "id" : "0b5633ba2b904511ad514346f4d23d4b", "name" : "name", "cap_white_list" : [ "cap1 cap2 ca* cap*" ], "description" : "description", "config" : { "llm_model_config" : { "base_model_type" : "string", "model_path" : "obs://bucketname/objectdir/modelpath/" } }, "create_time" : "2023-05-30T12:24:30.401Z", "create_user" : { "domain_name" : "string", "domain_id" : "0b5633ba2b904511ad514346f4d23d4b", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4d23d4b" } } } 状态码：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 表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]个字符。 默认取值：不涉及。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

URI PUT 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]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数解释：一个Model的名称。 约束限制：不涉及。 取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。 默认取值：不涉及。 description 否 String 参数解释：描述信息。 约束限制：不涉及。 取值范围：[0,1024]。 默认取值：不涉及。 current_version_id 否 String 参数解释：模型版本ID。 约束限制：系统自动生成无法修改，输入不生效。 取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 version 否 ModelVersionInput object 参数解释：模型每个版本的详细信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表4 ModelVersionInput 参数 是否必选 参数类型 描述 name 是 String 参数解释：模型版本名称。 约束限制：不涉及。 取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。 默认取值：不涉及。 description 否 String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 config 否 ModelConfig object 参数解释：模型配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表5 ModelConfig 参数 是否必选 参数类型 描述 llm_model_config 否 LlmModelConfig object 参数解释：Llm模型配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表6 LlmModelConfig 参数 是否必选 参数类型 描述 base_model_type 是 String 参数解释：基模型类型。请从ListBaseModels列举基模型接口响应中获取。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 model_path 是 String 参数解释：模型文件路径。 约束限制：合法OBS路径。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/features 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：[1,100]。 默认取值：10。

响应示例 状态码：200 OK。 { "configs" : [ { "key" : "test", "value" : "test" } ], "total" : 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" } 状态码：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参数 参数 参数类型 描述 configs Array of Feature objects 参数解释：配置列表。 约束限制：不涉及。 取值范围：[0,100000]。 默认取值：不涉及。 total Integer 参数解释：配置项总数。 约束限制：不涉及。 取值范围：[0,2147483647]。 默认取值：不涉及。 表4 Feature 参数 参数类型 描述 key String 参数解释：配置项key。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 value String 参数解释：配置项value。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

请求示例 部署一个服务实例，具体部署参数如下实例所示。 POST https://{endpoint}/v1/workspaces/{workspace_id}/services/instances { "source" : { "id" : "0b5633ba2b904511ad514346f4d23d4b", "version_id" : "0b5633ba2b904511ad514346f4d23d4b" }, "name" : "serviceInstanceName1", "description" : "description", "endpoint_id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6", "config" : { "model_instance_config" : { "resource" : { "min" : 1, "max" : 1000, "spec_code" : "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" } 状态码：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 表10 响应Body参数 参数 参数类型 描述 id InstanceId object 参数解释：实例ID。获取方法，请参见获取推理实例ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 表11 InstanceId 参数 参数类型 描述 - String 参数解释：实例ID。获取方法，请参见获取推理实例ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 状态码：400 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：401 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：403 Forbidden 状态码：404 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：408 表15 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：500 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。

响应示例 状态码：200 查询Endpoint列表的响应体。 { "total" : 1, "endpoints" : [ { "visibility" : "PRIVATE", "id" : "0b5633ba2b904511ad514346f4dxxxxx", "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" : "0b5633ba2b904511ad514346f4dxxxxx", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4xxxxx" }, "cap" : { "cap_id" : "0b5633ba2b904511ad514346f4xxxxx", "version_id" : "0b5633ba2b904511ad514346f4xxxxx" }, "reserved_resource" : { "apu" : { "spec_code" : "a1x", "warm_up_num" : 1, "max_num" : 100 }, "dpu" : { "spec_code" : "d1x", "warm_up_num" : 1, "max_num" : 100, "use_public_resource" : false }, "mu" : { "spec_code" : "mu", "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" } ] } 状态码：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 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释：符合条件的端点总数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 endpoints Array of EndpointBriefInfo objects 参数解释：符合条件的Endpoint简要信息列表。 约束限制：不涉及。 取值范围：[0,1000]。 默认取值：不涉及。 表5 EndpointBriefInfo 参数 参数类型 描述 visibility String 参数解释：可见性。 约束限制：不涉及。 取值范围： PRIVATE：私有 PUBLIC：公共 默认取值：PRIVATE。 id String 参数解释：Endpoint ID。 约束限制：不涉及。 取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 name String 参数解释：Endpoint名称。 约束限制：不涉及。 取值范围：长度为[1,128]包含中文、字母、数字、下划线、中划线、半角句号（.）、空格的组合。 默认取值：不涉及。 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 参数解释：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 cap CapRef object 参数解释：镜像包信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 reserved_resource ReservedResource object 参数解释：通用预留资源。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 ray_resource RayResourceInfo object 参数解释：Ray资源配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 caches Array of CacheConfig objects 参数解释：缓存关联信息。 约束限制：不涉及。 取值范围：[0,1000]。 默认取值：不涉及。 error_code String 参数解释：失败状态时的错误编码。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：失败状态时的错误信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表6 User 参数 参数类型 描述 domain_name String 参数解释：账户名称。 约束限制：不涉及。 取值范围：长度为[0,64]个字符。 默认取值：不涉及。 domain_id String 参数解释：账号ID。 约束限制：不涉及。 取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。 默认取值：不涉及。 user_name String 参数解释：用户名称。 约束限制：不涉及。 取值范围：长度为[0,64]个字符。 默认取值：不涉及。 user_id String 参数解释：用户ID。 约束限制：不涉及。 取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。 默认取值：不涉及。 表7 CapRef 参数 参数类型 描述 cap_id String 参数解释：镜像包ID。 约束限制：不涉及。 取值范围：长度为[32,36]的英文、数字、中划线(-)的组合。 默认取值：不涉及。 version_id String 参数解释：镜像包版本ID。 约束限制：不涉及。 取值范围：长度为[32,36]的英文、数字、中划线(-)的组合。 默认取值：不涉及。 表8 ReservedResource 参数 参数类型 描述 apu ResourceDef object 参数解释：资源定义信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 dpu SqlResourceDef object 参数解释：Sql资源定义信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 mu ResourceDemand object 参数解释：资源需求量配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表9 ResourceDef 参数 参数类型 描述 spec_code String 参数解释：Endpoint状态。 约束限制：资源规格编码，从查询规格列表ListSpecs接口获取。 取值范围：不涉及。 默认取值：不涉及。 warm_up_num Integer 参数解释：预热资源量。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 max_num Integer 参数解释：最大资源量，不填默认为预热资源量，即不使用弹性资源。 约束限制：不涉及。 取值范围：最小值为1，最大值为1000。 默认取值：不涉及。 表10 SqlResourceDef 参数 参数类型 描述 spec_code String 参数解释：Endpoint状态。 约束限制：资源规格编码，从查询规格列表ListSpecs接口获取。 取值范围：不涉及。 默认取值：不涉及。 warm_up_num Integer 参数解释：预热资源量。 约束限制：不涉及。 取值范围：最小值为1，最大值为1000。 默认取值：不涉及。 max_num Integer 参数解释：最大资源量，不填默认为预热资源量，即不使用弹性资源。 约束限制：不涉及。 取值范围：最小值为1，最大值为1000。 默认取值：不涉及。 use_public_resource Boolean 参数解释：是否使用公共资源。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表11 ResourceDemand 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 min Integer 参数解释：最小数。 约束限制：不涉及。 取值范围：最小值为0。 默认取值：不涉及。 max Integer 参数解释：最大数。 约束限制：不涉及。 取值范围：最小值为1。 默认取值：不涉及。 表12 RayResourceInfo 参数 参数类型 描述 head_group_spec HeadGroupSpec object 参数解释：Ray Head配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 worker_group_spec Array of WorkerGroupSpec objects 参数解释：Ray worker group配置。 约束限制：不涉及。 取值范围：[1,10]。 默认取值：不涉及。 表13 HeadGroupSpec 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 表14 WorkerGroupSpec 参数 参数类型 描述 name String 参数解释：名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 min_replicas Integer 参数解释：最小副本数。 约束限制：不涉及。 取值范围：最小值为0，最大值为10000。 默认取值：不涉及。 max_replicas Integer 参数解释：最大副本数。 约束限制：不涉及。 取值范围：最小值为1，最大值为10000。 默认取值：不涉及。 表15 CacheConfig 参数 参数类型 描述 mnt_path String 参数解释：挂载路径。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 cache_ins_id String 参数解释：分布式缓存id。 约束限制：不涉及。 取值范围：已创建的分布式缓存资源id。 默认取值：不涉及。 状态码：400 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：401 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：408 表18 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 状态码：500 表19 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/endpoints 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID，获取方法，请参见获取工作空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：[1,100]。 默认取值：10。 model_id 否 String 参数解释：通过模型ID检索。 约束限制：不涉及。 取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合，请参见获取模型ID。 默认取值：不涉及。 name 否 String 参数解释：Endpoint名称，通过名字搜索Endpoint的参数。 约束限制：不涉及。 取值范围：长度为[1,128]的中文、字母、数字、下划线(_)、中划线(-)，支持模糊查询。 默认取值：不涉及。 endpoint_id 否 String 参数解释：通过端点ID检索Endpoint的参数。获取方法，请参见获取端点ID。 约束限制：不涉及。 取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 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，不包括其他用户创建的。

URI DELETE https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 instance_id 是 String 参数解释：实例的ID。获取方法，请参见获取推理实例ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。