创建工作空间 - CreateWorkspace
功能介绍
创建工作空间。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/instances/{instance_id}/workspaces
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
实例ID。 |
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
configs |
否 |
Map<String,String> |
工作空间的configs配置的属性值。
|
|
name |
是 |
String |
工作空间名称。 |
|
description |
否 |
String |
工作空间描述。 |
|
eps_id |
是 |
String |
工作空间所属企业项目ID。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configs |
Map<String,String> |
工作空间的configs配置的属性值。
|
|
create_time |
Long |
创建时间。 |
|
create_user |
String |
创建人。 |
|
description |
String |
工作空间描述信息。 |
|
domain_id |
String |
工作空间所属的账号ID。 |
|
eps_id |
String |
工作空间所属企业项目的ID。 |
|
id |
String |
工作空间ID。 |
|
instance_id |
String |
实例ID。 |
|
is_default |
Integer |
是否为默认空间。 取值:0、1。 |
|
name |
String |
工作空间名称。 |
|
owner_name |
String |
工作空间所属人名称。 |
|
project_id |
String |
工作空间所在的项目ID。 |
|
update_time |
Long |
工作空间详情更新时间。 |
|
update_user |
String |
工作空间详情更新责任人。 |
请求示例
在项目下创建工作空间。
/v1/{project_id}/instances/{instance_id}/workspaces
{
"configs" : {
"mode" : "0",
"field_show_type" : "0",
"only_admin_create_datasource" : "0",
"works_authorized" : "0",
"works_public" : "1",
"works_view" : "0"
},
"name" : "测试name",
"description" : "这是一段测试描述",
"eps_id" : "0"
}
响应示例
{
"configs" : {
"mode" : "0",
"field_show_type" : "0",
"only_admin_create_datasource" : "0",
"works_authorized" : "0",
"works_public" : "1",
"works_view" : "0"
}
,
"create_time" : 1676984980510,
"create_user" : "xxxxxx",
"description" : "Description workspace information",
"domain_id" : "xxxxxxx",
"eps_id" : "xxxxxxxxxx",
"id" : "xxxxxxxxxxxxx",
"instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx",
"is_default" : 1,
"name" : "Example workspace name",
"owner_name" : "xxxxxx",
"project_id" : "xxxxxxxb4dac4055888643b3xxxxxx",
"update_time" : 1687167926377,
"update_user" : "xxxxxxxx"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。