huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BadRequestErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The parameter is invalid.","readOnly":true,"type":"string"}}},"CreateOrUpdateStoragePolicyStatementReq":{"description":"新增或更新存储目录访问权限自定义策略(已存在自定义策略时会对已有策略更新)。","properties":{"actions":{"description":"客户端访问存储可操作的权限合集\n允许为空,为空时配置了该策略的用户,通过云办公客户端接入后仅可查看文件列表,不可上传下载。\n* `PutObject` -  上传、修改、重命名、移动。\n* `DeleteObject` - 删除。\n* `GetObject` - 下载。\n注:PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。","example":["GetObject"],"items":{"maxLength":16,"minLength":1,"type":"string"},"maxItems":3,"minItems":0,"type":"array","uniqueItems":true,"x-annotations":"@Size(max = 3, min = 0)"},"roam_actions":{"description":"云端访问存储可操作的权限合集,不允许为空。\n* `PutObject` -  上传、修改、重命名、移动。\n* `DeleteObject` - 删除。\n* `GetObject` - 下载 。         \n注:PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。","example":["GetObject","DeleteObject","PutObject"],"items":{"maxLength":16,"minLength":1,"type":"string"},"maxItems":3,"minItems":1,"type":"array","uniqueItems":true}},"required":["roam_actions"]},"ForbiddenErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00081102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User does not have permission to access this resource.","readOnly":true,"type":"string"}}},"InternalServerErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211401","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The requested operation failed. Please try again later.","readOnly":true,"type":"string"}}},"MethodNotAllowedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00000405","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The method specified in the request is not allowed for this resource.","readOnly":true,"type":"string"}}},"NotFoundErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The application does not exist","readOnly":true,"type":"string"}}},"PolicyStatement":{"description":"支持的访问策略。","properties":{"actions":{"description":"客户端访问存储可操作的权限合集。\n* `PutObject` -  上传、修改、重命名、移动。\n* `GetObject` - 下载。\n* `DeleteObject` - 删除。","example":["GetObject"],"items":{"readOnly":true,"type":"string"},"readOnly":true,"type":"array"},"policy_statement_id":{"description":"支持的访问策略,内置如下四种策略:\n* `DEFAULT_1`:`客户端访问存储` - 上传、下载; `云端访问存储` - 读写。\n  - action: PutObject、DeleteObject、GetObject\n  - roam_action: PutObject、DeleteObject、GetObject\n* `DEFAULT_2`:`客户端访问存储` - 下载; `云端访问存储` - 读写。\n  - action: GetObject\n  - roam_action: PutObject、DeleteObject、GetObject\n* `DEFAULT_3`:`客户端访问存储` - 上传; `云端访问存储` - 读写。\n  - action: PutObject、DeleteObject\n  - roam_action: PutObject、DeleteObject、GetObject\n* `DEFAULT_4`:`客户端访问存储` - 仅可查看列表,不允许上传下载; `云端访问存储` - 只读。\n  - action: \n  - roam_action: GetObject","example":"DEFAULT_1","readOnly":true,"type":"string"},"roam_actions":{"description":"云端访问存储可操作的权限合集。\n* `PutObject` -  上传、修改、重命名、移动。\n* `GetObject` - 下载。\n* `DeleteObject` - 删除。","example":["GetObject"],"items":{"readOnly":true,"type":"string"},"readOnly":true,"type":"array"}}},"ServiceUnavailableErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00050902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The service is now unavailable to process the request.","readOnly":true,"type":"string"}}},"UnauthorizedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211302","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User authorization error.","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"dba6db925cc549daa556a08db483f4cf","info_version":"v1","method":"put","name":"CreateOrUpdateStoragePolicyStatement","parameters":{},"paths":{"/v1/{project_id}/storages-policy/actions/create-statements":{"put":{"description":"新增或更新存储目录访问权限自定义策略(已存在自定义策略时会对已有策略更新)。","operationId":"CreateOrUpdateStoragePolicyStatement","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":102400,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目ID。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"设置自定义权限策略内容。","in":"body","name":"CreateOrUpdateStoragePolicyStatementRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateOrUpdateStoragePolicyStatementReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"actions":["PutObject","DeleteObject","GetObject"],"policy_statement_id":"DEFAULT_1","roam_actions":["PutObject","DeleteObject","GetObject"]}},"schema":{"$ref":"#/definitions/PolicyStatement"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BadRequestErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/UnauthorizedErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ForbiddenErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/NotFoundErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/MethodNotAllowedErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"新增或更新存储目录访问权限自定义策略","tags":["Persistent"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal_token,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"PUT","name":"wks-appcenter-lb","path":"/v1/{project_id}/storages-policy/actions/create-statements","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_operate","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":12,"x-request-examples-url-1":"POST /v1/a4da8115c9d8464ead3a38309130523f/storages-policy/actions/create-statements","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"新增或更新存储目录访问权限自定义策略","tags":"存储管理","uri":null,"version":"2.0"}