华为云用户手册

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

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 total Integer 参数解释：总数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 spec_codes Array of Spec objects 参数解释：规格编码列表。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 表3 Spec 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 spec_type String 参数解释：资源规格类型。 约束限制：不涉及。 取值范围： APU：APU类型； SQL_DPU：SQL DPU类型； MU：MU类型； RESOURCE_USAGE_UNIT：资源使用量类型； RAY_APU：Ray APU类型； RAY_DPU：Ray DPU类型。 RAY_CACHE：Ray缓存资源。 默认取值：不涉及。 resource_type String 参数解释：资源类型。 约束限制：不涉及。 取值范围：最小长度为1，最大长度为64。 默认取值：不涉及。 stride Integer 参数解释：资源步长。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 unit String 参数解释：资源单位。 约束限制：不涉及。 取值范围：最小长度为1，最大长度为16。 默认取值：不涉及。 min_stride_num Integer 参数解释：资源步数。 约束限制：不涉及。 取值范围：最小为1，最大为10000。输入范围还需要满足规格列表接口的步长白名单。 默认取值：不涉及。 max_stride_num Integer 参数解释：资源步数。 约束限制：不涉及。 取值范围：最小为1，最大为10000。输入范围还需要满足规格列表接口的步长白名单。 默认取值：不涉及。 usage_measure_id Integer 参数解释：使用量单位标识。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 usage_factor String 参数解释：使用量因子。 约束限制：不涉及。 取值范围：最小长度为1，最大长度为32。 默认取值：不涉及。 stride_num_whitelist Array of integers 参数解释：步数白名单，返回时，步数必须是白名单中的值。 约束限制：不涉及。 取值范围：最小值为0，最大值为100。 默认取值：不涉及。 extra_info SpecExtraInfo object 参数解释：附加信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表4 SpecExtraInfo 参数 参数类型 描述 mu_multiple Double 参数解释：模型单元换算倍数 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 mu_code String 参数解释：模型单元编码。 约束限制：不涉及。 取值范围：长度[1,64]。 默认取值：不涉及。 状态码：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]个字符。 默认取值：不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 enable 是 Boolean 参数解释：是否开启 AOM 监控采集。 约束限制：不涉及。 取值范围：false为不开启监控采集，true开启监控采集。 默认取值：false。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码：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]个字符。 默认取值：不涉及。 状态码：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]个字符。 默认取值：不涉及。

响应示例 状态码：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 OK { "status" : 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 表4 响应Body参数 参数 参数类型 描述 - String 状态码：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]。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/sessions/{session_id}/statements/{statement_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 session_id 是 String 参数解释：SessionId的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 statement_id 是 String 参数解释：statement id。 约束限制：不涉及。 取值范围：长度为[1,64]的字母、数字、中划线(-)和下划线(_)的组合。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page_num 否 Integer 参数解释：查询页码。 约束限制：不涉及。 取值范围：[1,65535]。 默认取值：不涉及。 is_enable_obs_path 否 Boolean 参数解释：是否返回结果集的obs路径。 约束限制：不涉及。 取值范围：true：返回结果集的obs路径，false：返回结果集。 默认取值：不涉及。

响应示例 状态码：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 空响应。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：403 Forbidden 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。

URI POST https://localhost.com/v1/workspaces/{workspace_id}/sessions/{session_id}/statements/{statement_id}/cancel 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 session_id 是 String 参数解释：SessionId的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 statement_id 是 String 参数解释：statement id。 约束限制：不涉及。 取值范围：长度为[1,64]的字母、数字、中划线(-)和下划线(_)的组合。 默认取值：不涉及。

响应示例 状态码：200 OK { "status" : 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 表4 响应Body参数 参数 参数类型 描述 - String 状态码：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]。 默认取值：不涉及。

请求示例 在指定的session下执行SQL语句。用户可通过此接口执行SQL语句，输入为sql语句、端点id、SQL Session id、绑定参数等信息，返回语句执行结果或语句id。此接口为异步接口，配套使用接口ShowSqlStatementResult查询语句结果，无特殊场景。 POST https://endpoint/v1/workspaces/{workspace_id}/sessions/statements { "statement" : "select * from aaa", "limit" : 100, "session_id" : "string", "bindings" : [ [ "string" ] ], "is_sync" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数解释：vpcep客户端名称。 约束限制：不涉及。 取值范围：[1,64]。 默认取值：不涉及。

响应参数 状态码：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]个字符。 默认取值：不涉及。

响应示例 状态码：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" }

请求示例 创建vpcep客户端。具体请求配置如样例所示。 POST https://{endpoint}/v1/access-clients { "name" : "zzh_test001", "vpc_id" : "050e154d-9954-4929-b6d3-12af7c9213ac", "subnet_id" : "string", "subnet_ids" : [ "0d86d58d-d864-47ce-8dbd-5487ff1d59ba" ], "access_connections" : [ { "vpcep_id" : "string", "vpcep_service_name" : "string", "domain" : "string" } ] }

响应示例 状态码：200 创建接入客户端的响应体。 { "id" : "f7670aea-36a1-4bdf-ae99-963c33324370", "name" : "name", "status" : "RUNNING", "vpc_id" : "f18a378a-f26b-461d-985f-3f904e4cc544", "subnet_ids" : [ "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53" ], "access_connections" : [ { "vpcep_id" : "1851896e-3731-4072-8b4a-33e38ed2207b", "domain" : "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53", "ip" : "192.168.0.57", "owner" : "0676610f3a0a4c2c80c50bea7ddf18c1" } ], "create_time" : "2025-01-08T01:53:30.000+00:00" } 状态码：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参数 参数 参数类型 描述 id String 参数解释：id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 name String 参数解释：名称。 约束限制：不涉及。 取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、点(.)、空格的组合。 默认取值：不涉及。 status String 参数解释：接入状态。 约束限制：不涉及。 取值范围： CREATING：创建中； RUNNING：运行中； DELETING：删除中； DELETED：已删除； 默认取值：不涉及。 vpc_id String 参数解释：服务接入客户端的vpcID。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 subnet_ids Array of strings 参数解释：服务接入客户端的子网ID，多个子网用,连接。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 access_connections Array of AccessConnectionInfo objects 参数解释：接入连接列表。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表4 AccessConnectionInfo 参数 参数类型 描述 vpcep_id String 参数解释：vpcep id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 subnet_id String 参数解释：subnet_id id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 domain String 参数解释：接入 域名 ，通过IP接入访问fabric API时，需在请求头中添加HOST参数并传入该域名。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 ip String 参数解释：ipv4地址。 约束限制：ipv4地址。 取值范围：不涉及。 默认取值：不涉及 owner String 参数解释：拥有者。 约束限制：不涉及。 取值范围：长度[1,64]。 默认取值：不涉及。 状态码：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]个字符。 默认取值：不涉及。

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数解释：客户端名称。 约束限制：不涉及。 取值范围：长度为[4,32]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 vpc_id 否 String 参数解释：虚拟私有云id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 subnet_id 否 String 参数解释：子网ID。创建子网时由系统生成。 约束限制：不涉及。 取值范围：长度为[36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 subnet_ids 否 Array of strings 参数解释：所属子网组。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 access_connections 否 Array of AccessConnectionRequestBody objects 接入连接列表，当接入模式为CUSTOM模式时生效。 表2 AccessConnectionRequestBody 参数 是否必选 参数类型 描述 vpcep_id 否 String 参数解释：虚拟私有云终端节点ID。在 接入管理-创建客户端-前往VPC创建- VPC终端节点 创建和查看。 约束限制：不涉及。 取值范围：[0,64]。 默认取值：不涉及。 vpcep_service_name 否 String 参数解释：终端节点服务名称。 约束限制：不涉及。 取值范围：[0,64]。 默认取值：不涉及。 domain 否 String 参数解释：接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。

请求示例 创建Sql Session。用户通过此接口在某SQL端点创建SQL Session，通过输入端点id、LakeFormation配置，返回Session信息。此接口为同步接口，无配套使用接口和特殊场景。 POST https://endpoint/v1/workspaces/{workspace_id}/sessions { "endpoint_id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6", "lake_formation_config" : { "instance_id" : "0b5633ba2b904511ad514346f4d23d4b", "catalog" : "string" } }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 session_id String 参数解释：Session的ID。 约束限制：不涉及。 取值范围：长度为[1,32]的英文字符、数字和中划线(-)等特殊符号的组合。 默认取值：不涉及。 status String 参数解释：session的状态。 约束限制：不涉及。 取值范围：[0,64]。 默认取值：不涉及。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：403 Forbidden 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：408 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。

响应示例 状态码：200 获取session信息的响应。 { "session_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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户token。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 endpoint_id 是 EndpointId object 参数解释：endpoint空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 lake_formation_config 是 LakeFormationInfo object 参数解释：LakeFormation相关信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 wait_timeout 否 Integer 参数解释：创建session排队等待时间，单位秒。 约束限制：不涉及。 取值范围：[300,7200]。 默认取值：不涉及。 表4 EndpointId 参数 是否必选 参数类型 描述 - 否 String 参数解释：endpoint空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 表5 LakeFormationInfo 参数 是否必选 参数类型 描述 instance_id 是 String 参数解释：lakeformation实例ID。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 catalog 是 String 参数解释：lakeformation的catalog。 约束限制：不涉及。 取值范围：长度为[1,255]的英文字符、数字、中划线(-)和下划线(_)的组合。 默认取值：不涉及。

响应示例 状态码：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 DELETE https://localhost.com/v1/workspaces/{workspace_id}/sessions/{session_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 session_id 是 String 参数解释：SessionId的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。

响应参数 状态码：200 OK 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：403 Forbidden 状态码：404 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：408 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：不涉及。 取值范围：长度[8,36]。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度[2,4096]。 默认取值：不涉及。

响应示例 状态码：200 查询vpcep client列表响应体。 { "total" : 1, "access_client_infos" : [ { "id" : "f7670aea-36a1-4bdf-ae99-963c33324370", "name" : "name", "status" : "RUNNING", "vpc_id" : "f18a378a-f26b-461d-985f-3f904e4cc544", "subnet_ids" : [ "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53" ], "access_connections" : [ { "vpcep_id" : "1851896e-3731-4072-8b4a-33e38ed2207b", "domain" : "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53", "ip" : "192.168.0.57", "owner" : "0676610f3a0a4c2c80c50bea7ddf18c1" } ], "create_time" : "2025-01-08T01:53:30.000+00:00" } ] } 状态码：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参数 参数 参数类型 描述 access_client_infos Array of AccessClientInfo objects 参数解释：vpcepClient信息。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 total Integer 参数解释：记录数。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 表4 AccessClientInfo 参数 参数类型 描述 id String 参数解释：id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 name String 参数解释：名称。 约束限制：不涉及。 取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、点(.)、空格的组合。 默认取值：不涉及。 status String 参数解释：接入状态。 约束限制：不涉及。 取值范围： CREATING：创建中； RUNNING：运行中； DELETING：删除中； DELETED：已删除； 默认取值：不涉及。 vpc_id String 参数解释：服务接入客户端的vpcID。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 subnet_ids Array of strings 参数解释：服务接入客户端的子网ID，多个子网用,连接。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及。 access_connections Array of AccessConnectionInfo objects 参数解释：接入连接列表。 约束限制：不涉及。 取值范围：[0,100]。 默认取值：不涉及 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表5 AccessConnectionInfo 参数 参数类型 描述 vpcep_id String 参数解释：vpcep id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 subnet_id String 参数解释：subnet_id id。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 domain String 参数解释：接入域名，通过IP接入访问fabric API时，需在请求头中添加HOST参数并传入该域名。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及 ip String 参数解释：ipv4地址。 约束限制：ipv4地址。 取值范围：不涉及。 默认取值：不涉及 owner String 参数解释：拥有者。 约束限制：不涉及。 取值范围：长度[1,64]。 默认取值：不涉及。 状态码：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]个字符。 默认取值：不涉及。