响应示例 状态码：200 请求成功 { "create_time" : "2024-07-02T09:25:17Z+0800", "creator_id" : "b4*****************************46a", "creator_name" : "l0******", "description" : "我的工作空间", "domain_id" : "ac*****************************bf4", "domain_name" : "scc****09", "enterprise_project_id" : "", "enterprise_project_name" : "", "id" : "39*************bf", "is_view" : false, "modifier_id" : "", "modifier_name" : "", "name" : "我的工作空间", "project_id" : "15**************************da6", "project_name" : "project_name", "region_id" : "region_id", "update_time" : "2024-07-02T09:25:17Z+0800", "view_bind_id" : "", "view_bind_name" : "", "workspace_agency_list" : [ ] }

请求示例 创建工作空间请求体 { "name" : "我的工作空间", "region_id" : "region_id", "project_name" : "project_name", "enterprise_project_id" : "", "enterprise_project_name" : "", "tags" : [ { "key" : "tag1", "value" : "value1" } ], "description" : "我的工作空间" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 区域id enterprise_project_id 否 String 企业项目id enterprise_project_name 否 String 企业项目名称 view_bind_id 否 String 视图绑定的空间id is_view 否 Boolean 是否是视图 name 是 String 工作空间名称 description 否 String 工作空间描述 project_name 是 String 项目名称 tags 否 Array of TagsPojo objects 标签数组 表4 TagsPojo 参数 是否必选 参数类型 描述 key 否 String 标签key value 否 String 标签value

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 id String 工作空间id create_time String 创建时间 update_time String 更新时间 name String 工作空间名称 description String 工作空间描述 creator_id String 创建人id creator_name String 创建人名称 modifier_id String 修改人id modifier_name String 修改人名称 project_id String 所属项目id project_name String 所属项目名称 domain_id String 所属租户id domain_name String 所属租户名称 enterprise_project_id String 企业项目id enterprise_project_name String 企业项目名称 is_view Boolean 是否是视图 region_id String 区域id view_bind_id String 视图绑定的空间id view_bind_name String 视图绑定的空间名称 workspace_agency_list Array of workspace_agency_list objects 纳管空间列表 表6 workspace_agency_list 参数 参数类型 描述 project_id String 委托空间所属项目id id String 空间委托id name String 空间委托名称 region_id String 委托空间所属region id workspace_attribution String THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间 agency_version String 委托版本 domain_id String 委托租户id domain_name String 委托租户名称 iam_agency_id String iam委托id iam_agency_name String iam委托名称 resource_spec_code Array of strings 委托空间购买版本 selected Boolean 是否被视图选中 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String Error code. error_msg String Error description. 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String Error code. error_msg String Error description.

响应参数 状态码：200 请求成功 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String Error code. error_msg String Error description. 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String Error code. error_msg String Error description.

URI DELETE /v1/{project_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 permanent_delete 否 Boolean 是否永久删除， true or false

请求示例 创建工作空间。其名称为fabric，描述为fabric-description，对应的MetastoreID为xxxxxx，对应企业项目ID为01049549-82cd-4b2b-9733-ddb94350c125，对应标签有key1，值为value1，key2，值为value2。 POST https://{endpoint}/v1/workspaces { "name" : "fabric", "description" : "fabric-description", "metastore_id" : "xxxxxx", "enterprise_project_id" : "01049549-82cd-4b2b-9733-ddb94350c125", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

响应示例 状态码：200 创建工作空间列表响应体。 { "id" : "90a827a1-ca72-4be8-943b-774f94xxxxxx", "name" : "workspace1", "description" : "workspace1-description", "create_time" : "2025-01-10T03:37:12.000+00:00", "create_domain_name" : "create_domain_name_001", "create_user_name" : "create_user_name_001", "metastore_id" : "2180518f-42b8-4947-b20b-adfc539xxxxx", "access_url" : "https://:test.fabric.com/", "enterprise_project_id" : 0 } 状态码：400 BadRequest { "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" }, "error_code" : 403, "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" } 状态码：404 NotFound { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码：408 Request Time-out { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码：500 InternalServerError { "error_code" : "common.00000500", "error_msg" : "internal error" }

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

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释：工作空间名称。 约束限制：不涉及。 取值范围：长度为[4,32]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 description 否 String 参数解释：用户输入的描述。 约束限制：不涉及。 取值范围：长度为[0,255]个字符。 默认取值：不涉及。 metastore_id 否 String 参数解释：LakeFormation服务的实例ID，即MetaStoreID。 约束限制：不涉及。 取值范围：长度为[32,36]的字母、数字、中划线(-)组合。 默认取值：不涉及。 enterprise_project_id 否 String 参数解释：企业项目ID。获取方法，请参见获取企业项目ID。 约束限制：只有对接了企业项目才可以填写。 取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。 默认取值：0，即default。 tags 否 Array of ResourceTag objects 参数解释：资源标签。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表3 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 参数解释：资源标签的键。 约束限制：不涉及。 取值范围：长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值：不涉及。 value 否 String 参数解释：资源标签的值。 约束限制：不涉及。 取值范围：长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值：不涉及。

响应示例 状态码：200 创建工作空间成功的响应参数。 { "id" : "**d05d1a553b4e188ea878e7dcb85e**", "name" : "test-workspace", "description" : "It is a test project'", "owner" : "testUser", "create_time" : 1470000020000, "update_time" : 1470000030000, "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "test-eps", "auth_type" : "public", "status" : "NORMAL", "status_info" : "" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 owner String 创建者名称。 auth_type String 授权类型。默认值为PUBLIC。PUBLIC：租户内部公开访问。PRIVATE：仅创建者和主账号可访问。INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 enterprise_project_id String 企业项目ID。 update_time Integer 最后修改时间，UTC。 create_time Integer 创建时间，UTC。 enterprise_project_name String 企业项目名称。 name String 工作空间名称。 description String 工作空间描述。 id String 工作空间ID，系统生成的32位UUID，不带橫线。 status String 工作空间状态。 CREATE_FAILED：创建失败。 NORMAL：状态正常。 DELETING：正在删除。 DELETE_FAILED：删除失败。 status_info String 状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。 grants Array of grants objects 授权用户列表。默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。 表6 grants 参数 参数类型 描述 user_id String 用户ID,此参数与user_name必填一个。两者都填优先使用user_id。 user_name String IAM用户名称。此参数与user_id必填一个。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 grants 否 Array of grants objects 授权用户列表，默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。 auth_type 否 String 授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为PUBLIC。 PUBLIC：租户内部公开访问。 PRIVATE：仅创建者和主账号可访问。 INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 enterprise_project_id 否 String 企业项目ID。 name 是 String 工作空间名称。长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。 description 否 String 工作空间描述，默认为空。长度限制为0-256字符。 表4 grants 参数 是否必选 参数类型 描述 user_id 否 String IAM用户ID。此参数与user_name必填一个。两者都填优先使用user_id。 user_name 否 String IAM用户名称。此参数与user_id必填一个。

请求示例 创建工作空间。设置工作空间名称为“test-workspace”，授权类型为“internal”，授权的IAM用户名称为“test”。 POST https://{endpoint}/v1/{project_id}/workspaces { "name" : "test-workspace", "description" : "It is a test project", "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "auth_type" : "internal", "grants" : [ { "user_name" : "test" } ] }