调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
| workspace:storage:createShareFolder | Write | storage * | - | - | - obs:object:getObject
- obs:object:putObject
|
URI
POST /v1/{project_id}/persistent-storages/{storage_id}/actions/create-share-folder
表1 路径参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| project_id | 是 | String | 项目ID。 |
| storage_id | 是 | String | WKS存储ID。 |
请求参数
表3 请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| folder_name | 否 | String | |
响应参数
状态码:200
表4 响应Body参数 | 参数 | 参数类型 | 描述 |
| storage_claim_id | String | WKS存储目录声明ID。 |
| folder_path | String | 存储对象路径。 注: path是对象在系统中的完整路径。 例如系统中存在如下目录结构的数据。 SFS-Tmp: └─shares ├─image └─video image的路径: shares/image/ video的路径: shares/video/ |
| delimiter | String | 路径分隔符。 |
| claim_mode | String | 存储声明的类型: |
状态码:400
表5 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:401
表6 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:403
表7 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:404
表8 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:405
表9 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:500
表10 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:503
表11 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
请求示例
POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/566337783841423360/actions/create-share-folder
{
"folder_name" : "tmp"
} 响应示例
状态码:200
成功响应。
{
"storage_claim_id" : 569314983280640000,
"folder_path" : "shares/video/",
"delimiter" : "/",
"claim_mode" : "SHARE"
} 状态码
| 状态码 | 描述 |
| 200 | 成功响应。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 405 | 请求中指定的方法不被允许。 |
| 500 | 服务内部错误,具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。 |