更新工作空间
功能介绍
更新工作空间。用户可通过该接口更新工作空间,支持传入名称、描述、MetaStoreID,返回更新后的工作空间详情。此接口为同步接口,无配套使用接口和特殊场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT https://localhost.com/v1/workspaces/{workspace_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace_id |
是 |
String |
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
|
description |
否 |
String |
|
metastore_id |
否 |
String |
|
enterprise_project_id |
否 |
String |
|
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
|
name |
String |
|
description |
String |
|
create_time |
String |
|
create_domain_name |
String |
|
create_user_name |
String |
|
metastore_id |
String |
|
access_url |
String |
|
enterprise_project_id |
String |
|
tags |
Array of ResourceTag objects |
|
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
|
value |
String |
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:408
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
请求示例
更新工作空间名称为fabric,更新描述为fabric-description,更新对应MetastoreID为xxxxxx。
PUT https://{endpoint}/v1/workspaces/{workspace_id}
{
"name" : "fabric",
"description" : "fabric-description",
"metastore_id" : "xxxxxx"
}
响应示例
状态码:200
更新工作空间列表响应体。
{
"id" : "exxxx0ef-f4eb-4b95-aff1-9d33ae9fxxxx",
"name" : "fabric",
"description" : "fabric-description",
"create_time" : "2023-05-30T12:24:30.401Z",
"create_domain_name" : "domain_name",
"create_user_name" : "user_name",
"metastore_id" : "2xxx518f-42b8-4947-b20b-adfcxxx81a2x",
"access_url" : "https://:test.fabric.com/",
"enterprise_project_id" : "01049549-82cd-4b2b-9733-ddb9435xxxxx"
}
状态码: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 |
更新工作空间列表响应体。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
NotFound |
408 |
Request Time-out |
500 |
InternalServerError |
错误码
请参见错误码。