-
请求示例 创建工作空间。其名称为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的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值:不涉及。
-
命令示例 本节以Windows为例介绍ai4s-toolkit的使用过程,Linux、macOS和Windows环境使用方法基本相同,可参考此章节。 不指定参数。 执行ai4s get project命令获取当前用户有权限访问的空间列表。 ai4s get project
# 执行成功返回结果如下
Project Name Project Id Owner Role Status Size Created Modified
maomaochong XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ei_eihealth_lxxx_01 Administrator ACTIVE 23.76GB 2025-04-24 10:35:29 2025-04-30 10:20:03
test-project-0421 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ei_eihealth_lxxx_01 Administrator ACTIVE 21.95MB 2025-04-21 11:24:06 2025-04-22 14:41:39
liuyuwei XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX test-liuyw Administrator ACTIVE 704.16MB 2025-04-07 04:20:58 2025-04-18 06:17:32
eihealth_api_project_002 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX eihealth_api_001 Administrator ACTIVE 37.52GB 2025-04-03 09:44:50 2025-04-03 10:05:15
test-whh XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX test-wwx-0331 Owner ACTIVE 308.52GB 2025-04-01 05:08:06 2025-04-01 05:08:07
test-hxy XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ei_eihealth_lxxx_01 Uploader ACTIVE 163.22GB 2025-03-31 12:01:17 2025-03-31 12:01:17
eihealth_api_project_006 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX eihealth_api_002 Administrator ACTIVE 11.10GB 2025-03-31 05:38:22 2025-04-03 09:39:37
eihealth_api_project_004 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX eihealth_api_002 Administrator ACTIVE 37.52GB 2025-03-31 05:37:55 2025-04-03 09:39:26
eihealth_api_project_001 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX eihealth_api_001 Administrator ACTIVE 62.13GB 2025-03-31 05:34:21 2025-04-03 09:39:44
test-bjl XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ei_eihealth_lxxx_01 Administrator ACTIVE 352.66GB 2025-03-31 05:26:06 2025-03-31 05:26:07 指定“project-name”参数。 例如查看名为“test-zh-0507”空间信息,执行ai4s get project test-bjl命令。 ai4s get project test-bjl
# 执行成功返回结果如下
{
"id": "XXXXX",
"name": "test-bjl",
"creator": "xxx",
"role": "Administrator",
"roles": [
{
"role_type": "Owner",
"users": [
{
"id": "XXXX",
"name": "XXXX"
}
]
},
{
"role_type": "XXXX",
"users": [
{
"id": "XXXX",
"name": "user007"
},
{
"id": "XXXXX",
"name": "cpp-test"
},
{
"id": "XXXXX",
"name": "test-bjl13"
},
{
"id": "XXXXX",
"name": "yjn-test"
}
]
}
],
"size": XXXX,
"status": "ACTIVE",
"description": "",
"create_time": "2025-03-31T02:26:06Z",
"update_time": "2025-03-31T02:26:07Z",
"is_core": false,
"storage_quota": -1,
"storage_tenant": "TERMINATE"
}
指定“--current”和“--policy”参数。 先执行ai4s switch project test-bjl,切换到“test-bjl”空间,再执行ai4s get project --current --policy命令,查询当前所在空间的详细信息、数据权限策略。 ai4s get project test-bjl --current --policy
# 执行成功返回结果如下
{
"id": "XXXXX",
"name": "test-bjl",
"creator": "xxx",
"role": "Administrator",
"roles": [
{
"role_type": "Owner",
"users": [
{
"id": "XXXXX",
"name": "xxx"
}
]
},
{
"role_type": "Administrator",
"users": [
{
"id": "XXXXX",
"name": "user007"
},
{
"id": "XXXXX",
"name": "cpp-test"
},
{
"id": "XXXXX",
"name": "test-bjl13"
}
]
}
],
"size": XXXXX,
"status": "ACTIVE",
"description": "",
"create_time": "2025-03-31T02:26:06Z",
"update_time": "2025-03-31T02:26:07Z",
"is_core": false,
"storage_quota": -1,
"storage_tenant": "TERMINATE"
}
-
空间设置 空间设置是对空间的管理,主要包含展示空间信息、更新空间描述、转移空间和删除空间等功能。 图1 空间设置 展示空间信息 单击“空间设置”后,展示空间信息,包含项目名称、描述、OBS桶名称。 更新空间描述 用户可以在描述中直接修改内容,单击描述外的区域后,空间描述会被更新为填写的内容。 转移空间 单击“转移空间”,选择新的“空间所有者”,可以将当前空间转移给所选的空间所有者,即项目所有者会发生变化。 图2 转移空间 删除空间 单击“删除空间”,输入“确认删除”,可以删除当前空间。 图3 删除空间 删除空间后,空间内的资产、Notebooks和作业会同步删除,删除空间不可逆,请谨慎操作。 父主题: 空间管理
-
邀请成员 用户登录
TICS 控制台。 进入TI
CS 控制台后,单击页面左侧“空间管理”,进入空间管理页面。 在空间管理页面,打开“我创建的空间”页签,查找需要邀请合作方的空间并单击“邀请合作方”。 图1 邀请合作方操作入口 在弹出的界面配置待邀请的合作方的“租户名称”和“租户别名”,保存后单击“确定”,完成邀请合作方操作。 “租户名称”是指合作方的华为账号,如何获取请参考合作方如何获取租户名称。 “租户别名”是合作方在TICS中的别名,由用户自定义即可,设置该参数的目的是保护合作方的信息安全。 图2 添加合作方
-
下载计算节点配置信息 下载计算节点配置信息,下载的信息可在部署计算节点的时候导入。“空间信息”代表“部署计算节点”属于哪个空间,用户输入的数据就会在哪个空间中参与计算。 配置包含空间证书,用于计算节点之间通信双向认证。证书保证了空间下的用户,部署的计算节点能够数据交互,参与计算。同时,也隔离了不同空间之间的数据访问。 用户登录TICS控制台。 进入TICS控制台后,单击页面左侧“通知管理”,进入通知管理页面。 浏览通知信息,单击“下载计算节点配置”,得到agentConfig.zip文件,解压到本地。内容如下: json文件:对应空间配置,包含“空间区域”、“空间名称”、“空间ID”、“证书密码”等。 p12文件:计算节点的密钥文件。 jks文件:CA的“证书”,密钥和证书保证了空间下的用户,部署的计算节点能够数据交互,参与计算。同时,也隔离了不同空间之间的数据访问。 图6 下载计算节点配置
-
查看空间详情 空间发起人登录TICS控制台。 进入TICS控制台后,单击页面左侧“空间管理”,进入空间管理页面。 在“空间管理”页打开“我参与的空间”页签,单击“空间名称”进入详情页。 查看空间统计信息 在详情页下方单击“空间概览”页签查看空间统计信息,该统计信息不是实时的,当前只显示统计到前一天的数据。 图1 空间统计信息 查看空间的合作方列表 在详情页下方单击“合作方管理”页签查看空间的合作方列表。 图2 合作方列表 查看空间的合作方数据 在详情页下方单击“合作方数据”页签查看注册到空间的合作方数据列表。 图3 合作方数据 查看
可信计算 环境 在详情页下方单击“可信计算环境”页签查看注册到空间的可信节点列表。 图4 可信计算环境
-
查看空间操作记录 TICS提供透明的空间操作记录。空间的创建、部署、删除、升级回滚操作都会被详细记录。 在详情中,操作进程以可视化的方式展示,清晰展示空间的部署、升级、回滚、删除步骤,在出现问题时便于分析排查。 用户登录TICS控制台。 进入TICS控制台后,单击页面左侧“空间管理”,进入空间管理页面。 单击页面右上角的“操作记录”按钮,查看操作记录。 图9 入口 单击“查看详情”,可查看空间操作的具体信息。 图10 查看详情 操作详情以可视化的形式展示,使操作进程更直观、更清晰。 图11 可视化页面
-
处理方法 执行以下命令,排查磁盘的物理空间是否已满。 df -h 图1 检查磁盘物理空间 如图1所示,磁盘空间还有剩余,排除物理磁盘空间已满的情形 执行以下命令,查看系统可用的inode节点使用率。 df -i 当结果中的Use%为100%时则为inode耗尽,可以执行以下的操作步骤释放inode。 执行以下命令,将所有在目录文件进行归档。 tar czvf /tmp/backup.tar.gz /home/data 删除对应目录下确认不需要的文件释放inode。
-
应用说明 服务内置了多种应用,方便用户使用,具体描述如表5所示。 表5 内置应用说明 名称 描述 操作类型 数据库下载 该类应用允许用户下载结构化数据,如CSV和JDBC类型的数据。 下载:用户可使用该应用下载数据到数据库。 数据库预览 该类应用允许用户查看结构化数据如CSV和JDBC类型的数据。 查看:用户可使用该应用预览查看数据库数据。 PDF查看 该类应用允许用户预览查看PDF文件,仅供测试。 查看:用户可使用该应用预览查看PDF文件。 文档本地下载 该类应用允许用户下载数据到本地。 下载:用户可使用该应用下载数据到本地。 LUCKY_EXCEL 该类应用允许用户预览查看Excel文件,仅供测试。 查看:用户可使用该应用预览查看Excel文件。 文档远程下载 该类应用允许用户下载SFTP、FTP、OBS等非结构化数据。 下载:用户下载SFTP、FTP、OBS等非结构化数据。 图片预览 该类应用允许用户预览图片文件。 查看:用户可以使用该应用预览查看图片文件。
-
响应示例 状态码:200 部门空间列表信息。 {
"total" : 364,
"departments" : [ {
"tenantId" : "40086000004871666",
"creator" : "369528171409614001",
"createTime" : "2023-11-14T20:39:06.000Z",
"modifier" : "369528171409614001",
"updateTime" : "2023-12-26T11:40:08.000Z",
"ownerId" : "1289173668999530369",
"status" : 0,
"capacity" : 1,
"spaceUsed" : 654777,
"containerId" : "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b",
"bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b",
"bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b",
"id" : "1289173668999530369",
"parentId" : "1289171275545118721",
"name" : "部门1699953477584",
"userNum" : 1
}, {
"tenantId" : "40086000004871666",
"id" : "1289173650183882753",
"parentId" : "1289171275545118721",
"name" : "部门1699953475619"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173631275960193",
"parentId" : "1289171275545118721",
"name" : "部门1699953473454"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173612200265729",
"parentId" : "1289171275545118721",
"name" : "部门1699953470101"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173593258788737",
"parentId" : "1289171275545118721",
"name" : "部门169995346896"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173574392809473",
"parentId" : "1289171275545118721",
"name" : "部门1699953466973"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173555140953985",
"parentId" : "1289171275545118721",
"name" : "部门1699953463567"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173535931041664",
"parentId" : "1289171275545118721",
"name" : "部门1699953461741"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173517174114305",
"parentId" : "1289171275545118721",
"name" : "部门1699953459399"
}, {
"tenantId" : "40086000004871666",
"id" : "1289173498115196929",
"parentId" : "1289171275545118721",
"name" : "部门1699953457405"
} ],
"code" : 0,
"msg" : "成功"
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 code Integer 错误码 msg String 错误信息 total String 总数 departments Array of departmentSpaceInfo objects 部门空间信息 表4 departmentSpaceInfo 参数 参数类型 描述 id String 部门ID parentId String kooDrive中的父部门ID name String 部门名称 tenantId String 租户标识