华为云用户手册

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

URI GET https://localhost.com/v1/access-clients 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：[1,100]。 默认取值：10。 name 否 String 参数解释：通过vpcep client名称搜索vpcep客户端，支持模糊搜索。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、中文字符、数字、中划线(-)和下划线(_)的组合。 默认取值：不涉及。 id 否 String 参数解释：通过vpcep client ID搜索客户端。 约束限制：不涉及。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。

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

URI GET 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 表3 响应Body参数 参数 参数类型 描述 session_id String 参数解释：Session的ID。 约束限制：不涉及。 取值范围：长度为[1,32]的英文字符、数字和中划线(-)等特殊符号的组合。 默认取值：不涉及。 status String 参数解释：session的状态。 约束限制：不涉及。 取值范围：[0,64]。 默认取值：不涉及。 状态码：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]。 默认取值：不涉及。

响应示例 状态码：200 Sql执行历史记录响应体。 { "total" : 1, "records" : [ { "id" : "0b5633ba2b904511ad514346f4dxxxxx", "workspace_id" : "0b5633ba2b904511ad514346f4d23d4b", "endpoint_id" : "0b5633ba2b904511ad514346f4d23d4b", "database_name" : "db1", "statement_content" : "select 1", "dpu_duration" : 2.23, "dpu_cost" : 10.11, "duration" : 332, "status" : "SUC CES SFUL", "create_time" : "2023-05-30T12:24:30.401Z", "start_time" : "2023-05-30T12:24:30.401Z", "finish_time" : "2023-05-30T12:24:30.401Z" } ] } 状态码：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参数 参数 参数类型 描述 total Integer 参数解释：符合条件的sql记录总数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 records Array of StatementRecord objects sql历史记录。 表5 StatementRecord 参数 参数类型 描述 id String Sql执行StatementID。 workspace_id String 参数解释：工作空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 endpoint_id EndpointId object 参数解释：endpoint空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 database_name String 参数解释：数据库名称。 约束限制：不涉及。 取值范围：长度为[1,256]的字母、数字、下划线(_)的组合。 默认取值：不涉及。 statement_content String 参数解释：sql脚本内容。 约束限制：不涉及。 取值范围：长度为[1,1024]的中文、字母、数字、中划线(-)、下划线(_)的组合。 默认取值：不涉及。 dpu_duration String 参数解释：dpu时。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 duration String 参数解释：执行时长。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 dpu_cost String 参数解释：费用。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 status String 参数解释：Sql执行状态。 约束限制：不涉及。 取值范围：CANCELED|FAILED|SUCCESSFUL|RUNNING|SUBMITTED|ERROR。 默认取值：不涉及。 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 start_time String 参数解释：sql执行开始时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 finish_time String 参数解释：sql执行结束时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表6 EndpointId 参数 参数类型 描述 - String 参数解释：endpoint空间ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 状态码：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]。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/statement-records 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 endpoint_id 否 String 参数解释：通过ID检索Endpoint的参数。 约束限制：不涉及。 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。 默认取值：不涉及。 statement_id 否 String 参数解释：statement id。 约束限制：不涉及。 取值范围：长度为[1,64]的字母、数字、中划线(-)和下划线(_)的组合。 默认取值：不涉及。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：[1,100]。 默认取值：10。 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 source 否 Integer 参数解释：执行sql来源，0 API，1 Console。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 start_time 否 Integer 参数解释：查询开始时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 end_time 否 Integer 参数解释：查询完成时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。

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

响应示例 状态码：200 查询vpcep client详情响应体。 { "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" }

操作场景 GA可以针对客户访问的业务为访问者提供个性化的管理策略，制定策略之前需要获取来访者的真实IP。TOA内核模块主要用来获取来访者的真实IP，该插件安装在GA真实终端节点的服务器内。 本文档仅适用于四层（TCP协议）服务，用户IP地址类型为IPv4，当用户需要在操作系统中编译TOA内核模块时，可参考本文档进行配置。 Linux内核版本为2.6.32和Linux内核版本为3.0以上的操作系统，在配置TOA内核模块的操作步骤上有所区别，具体操作请参照相应的操作步骤进行配置。

操作场景 GA可以针对客户访问的业务为访问者提供个性化的管理策略，制定策略之前需要获取来访者的真实IP。TOA内核模块主要用来获取来访者的真实IP，该插件安装在GA真实终端节点的服务器内。 本文档仅适用于四层（TCP协议）服务，用户IP地址类型为IPv4，当用户需要在操作系统中编译TOA内核模块时，可参考本文档进行配置。 Linux内核版本为2.6.32和Linux内核版本为3.0以上的操作系统，在配置TOA内核模块的操作步骤上有所区别，具体操作请参照相应的操作步骤进行配置。

什么是多因素认证 多因素认证是一种非常简单的安全实践方法，它能够在用户名称和密码之外再额外增加一层保护。启用多因素认证后，用户进行操作时，除了需要提供用户名和密码外（第一次身份验证），还需要提供验证码（第二次身份验证），多因素身份认证结合起来将为您的账号和资源提供更高的安全保护。 多因素认证主要应用在登录验证和操作保护中，开启了登录验证功能后，用户登录控制台时，除了需要输入用户名和密码外，还需要在登录验证页面输入验证码；开启了操作保护后，用户进行敏感操作时，需要输入验证码确认操作。

多因素认证应用的场景 多因素认证主要应用于登录保护以及操作保护。若开启多因素认证，则管理控制台和REST API均会受到影响。 登录保护：您以及账号中的 IAM 用户登录时，除了在登录页面输入用户名和密码外，还需要在登录验证页面输入多因素认证设备中的验证码，再次确认登录者身份，进一步提高账号安全性。 操作保护：您以及账号中的IAM用户进行敏感操作时，例如删除弹性云服务器资源，需要输入多因素认证设备中的验证码对操作进行确认，避免误操作带来的风险和损失。 更多有关登录保护和操作保护的介绍，请参见：开启或关闭敏感操作。