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":{"AttachType":{"description":"关联对象类型:\n* `USER` -  用户\n* `USER_GROUP` - 用户组","enum":["USER","USER_GROUP"],"example":"USER","type":"string"},"Attachment":{"description":"配置关联成员。","properties":{"attach":{"description":"目标。","example":"USER001***@local.com","maxLength":128,"minLength":1,"type":"string"},"attach_type":{"$ref":"#/definitions/AttachType"}},"required":["attach","attach_type"]},"BaseResp":{"description":"API响应基类。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00139901","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","readOnly":true,"type":"string"}}},"ClaimMode":{"description":"存储声明的类型:\n* `USER` -  用户目录\n* `SHARE` - 共享目录","enum":["USER","SHARE"],"example":"SHARE","type":"string"},"ListStorageAssignmentResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"查询用户存储声明配置。","items":{"$ref":"#/definitions/PersistentStorageAssignment"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询用户存储声明配置。"},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"PersistentStorageAssignment":{"allOf":[{"$ref":"#/definitions/PersistentStorageClaim"},{"properties":{"attachment":{"$ref":"#/definitions/Attachment"},"policy_statement":{"$ref":"#/definitions/PolicyStatement"},"storage_metadata":{"$ref":"#/definitions/StorageMetadata"}},"type":"object"}],"description":"存储声明关联作用对象。"},"PersistentStorageClaim":{"description":"基于WKS存储创建的,文件夹存储声明。","properties":{"claim_mode":{"$ref":"#/definitions/ClaimMode"},"delimiter":{"description":"路径分隔符。","example":"/","readOnly":true,"type":"string"},"folder_path":{"description":"存储对象路径。\n注: path是对象在系统中的完整路径。\n例如系统中存在如下目录结构的数据。\nSFS-Tmp:\n└─shares\n  ├─image\n  └─video\nimage的路径: shares/image/\nvideo的路径: shares/video/","example":"shares/video/","readOnly":true,"type":"string"},"storage_claim_id":{"description":"WKS存储目录声明ID。","example":"xxx-xxx-x-xxx","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"}}},"Storage":{"description":"存储定义元数据。","properties":{"storage_class":{"description":"存储类型:\n* `sfs` - sfs3.0存储。","example":"sfs","maxLength":128,"minLength":1,"type":"string"},"storage_handle":{"description":"SFS文件系统名称。","example":"sfs-tmp","maxLength":128,"minLength":1,"type":"string"}},"required":["storage_class","storage_handle"]},"StorageMetadata":{"allOf":[{"$ref":"#/definitions/Storage"},{"properties":{"export_location":{"description":"访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。","example":"https://sfs3.xxxx.myhuaweicloud.com:443","readOnly":true,"type":"string"},"name":{"description":"名称。","example":"sfs-tmp","readOnly":true,"type":"string"},"region":{"description":"所在区域。","example":"cn-north-5","readOnly":true,"type":"string"}},"type":"object"}],"description":"存储定义。"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"19264d34811e41a281155a06a4762f15","info_version":"v1","method":"get","name":"ListStorageAssignment","parameters":{},"paths":{"/v1/{project_id}/persistent-storages/actions/list-attachments":{"get":{"description":"查询个人存储目录。","operationId":"ListStorageAssignment","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"},{"default":0,"description":"查询的偏移量。","in":"query","maximum":2147483646,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":"0"},{"default":10,"description":"单次查询的大小[1-100]。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":"10"},{"description":"WKS存储ID。","in":"query","name":"storage_id","pattern":"[\\S ]{0,128}$","required":true,"type":"string"},{"description":"存储声明的类型,claim_mode为share时,storage_claim_id必填。\n* `USER` -  用户目录\n* `SHARE` - 共享目录","in":"query","name":"claim_mode","pattern":"(USER|SHARE)","required":true,"type":"string"},{"description":"WKS存储目录声明ID。","in":"query","name":"storage_claim_id","pattern":"[\\S ]{0,128}$","required":false,"type":"string"},{"description":"成员。","in":"query","name":"attach","pattern":"[\\S ]{0,128}$","required":false,"type":"string"},{"description":"关联对象类型:\n* `USER` -  用户\n* `USER_GROUP` - 用户组","in":"query","name":"attach_type","pattern":"(USER|USER_GROUP)","required":false,"type":"string"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":1,"items":[{"attachment":{"attach":"USER001***@local.com","attach_type":"USER"},"claim_mode":"SHARE","delimiter":"/","folder_path":"shares/video/","policy_statement":{"actions":["GetObject"],"policy_statement_id":"xxxxx-xxx-xx"},"storage_claim_id":544959151881584640,"storage_metadata":{"export_location":"https://sfs3.cn-north-xx.myhuaweicloud.com:443","name":"sfs-tmp","region":"cn-north-5","storage_class":"sfs","storage_handle":"sfs-tmp"}}]}},"schema":{"$ref":"#/definitions/ListStorageAssignmentResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/BaseResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/BaseResp"}}},"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":"GET","name":"wks-appcenter-lb","path":"/v1/{project_id}/persistent-storages/actions/list-attachments","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"},{"description":"","in":"QUERY","name":"offset","origin":"request","value":"offset"},{"description":"","in":"QUERY","name":"limit","origin":"request","value":"limit"},{"description":"","in":"QUERY","name":"storage_id","origin":"request","value":"storage_id"},{"description":"","in":"QUERY","name":"claim_mode","origin":"request","value":"claim_mode"},{"description":"","in":"QUERY","name":"storage_claim_id","origin":"request","value":"storage_claim_id"},{"description":"","in":"QUERY","name":"attach","origin":"request","value":"attach"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_base_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":10,"x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/actions/list-attachments?storage_id=544959151881584640&claim_mode=SHARE&limit=10&offset=0","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"}