调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
| workspace:storage:updateShareFolderAssignment | Write | storage * | - | - | - |
URI
POST /v1/{project_id}/persistent-storages/{storage_id}/actions/assign-share-folder
表1 路径参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| project_id | 是 | String | 项目ID。 |
| storage_id | 是 | String | WKS存储ID。 |
请求参数
表3 请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| storage_claim_id | 是 | String | WKS存储目录声明ID。 |
| add_items | 否 | Array of Assignment objects | 增加的成员列表。 |
| del_items | 否 | Array of Attachment objects | 移除的成员列表。 |
表4 Assignment | 参数 | 是否必选 | 参数类型 | 描述 |
| policy_statement_id | 是 | String | 策略ID。 |
| attach | 是 | String | 目标。 |
| attach_type | 是 | String | 关联对象类型: -
USER - 用户 -
USER_GROUP - 用户组 |
表5 Attachment | 参数 | 是否必选 | 参数类型 | 描述 |
| attach | 是 | String | 目标。 |
| attach_type | 是 | String | 关联对象类型: -
USER - 用户 -
USER_GROUP - 用户组 |
响应参数
状态码:200
成功响应。
状态码:400
表6 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:401
表7 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:403
表8 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:404
表9 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:405
表10 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:500
表11 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:503
表12 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
请求示例
POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/544959151881584640/actions/assign-share-folder
{
"storage_claim_id" : 544959151881584640,
"add_items" : [ {
"attach" : "USER001***@local.com",
"attach_type" : "USER",
"policy_statement_id" : 1
} ],
"del_items" : [ {
"attach" : "USER001***@local.com",
"attach_type" : "USER"
} ]
} 状态码
| 状态码 | 描述 |
| 200 | 成功响应。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 405 | 请求中指定的方法不被允许。 |
| 500 | 服务内部错误,具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。 |