删除工作空间
功能介绍
删除工作空间接口用于移除已创建的工作空间。该接口适用于以下场景:当工作空间不再需要或需要清理资源时,用户可通过此接口删除指定的工作空间。使用该接口的前提条件是工作空间已存在且用户具有删除工作空间的权限。删除操作完成后,工作空间将被永久移除,相关资源也将被清理。若工作空间不存在或用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
DELETE /v1/{project_id}/workspaces/{workspace_id}
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
workspace_id |
String |
参数解释: 工作空间ID。获取方法请参见查询工作空间列表。 取值范围: 未创建工作空间无默认值,存在创建并使用的工作空间,以实际取值为准。 |
请求示例
如下以删除uuid为ccd05d1a553b4e188ea878e7dcb85e47的工作空间为例。
DELETE https://{endpoint}/v1/{project_id}/workspaces/ccd05d1a553b4e188ea878e7dcb85e47
响应示例
状态码:200
删除工作空间成功的响应参数。
{ "workspace_id" : "ccd05d1a553b4e188ea878e7dcb85e47" }
状态码
状态码 |
描述 |
---|---|
200 |
删除工作空间成功的响应参数。 |
错误码
请参见错误码。