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"}}},"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"}}},"ListPersistentStorageResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"存储列表。","items":{"$ref":"#/definitions/PersistentStorage"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询WKS存储。"},"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"}}},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"PersistentStorage":{"description":"WKS存储。","properties":{"create_time":{"description":"创建时间。","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"WKS存储ID。","example":"xxx-xxx-x-x-x-xx","readOnly":true,"type":"string"},"name":{"description":"名称。","example":"user-file-persistent","readOnly":true,"type":"string"},"share_claim_count":{"description":"共享目录声明数量。","readOnly":true,"type":"integer"},"storage_metadata":{"$ref":"#/definitions/StorageMetadata"},"user_claim_count":{"description":"个人目录声明数量。","readOnly":true,"type":"integer"}}},"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"}}},"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":"存储定义。"},"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":"da73a0e7cffb43b28a7aeb52663587c4","info_version":"v1","method":"get","name":"ListPersistentStorage","parameters":{},"paths":{"/v1/{project_id}/persistent-storages":{"get":{"description":"查询WKS存储。","operationId":"ListPersistentStorage","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","maxLength":128,"minLength":1,"name":"storage_id","required":false,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"查询名称,模糊匹配。","in":"query","maxLength":128,"minLength":0,"name":"name","required":false,"type":"string"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":1,"items":[{"create_time":"2023-06-08T07:08:09.412Z","id":"94b8e5c7-008f-40d7-b59a-084de3638286","name":"user-file-persistent","share_claim_count":0,"storage_metadata":{"export_location":"https://sfs3.cn-****myhuaweicloud.com:443","name":"sfs-tmp","region":"cn-north-5","storage_class":"sfs","storage_handle":"sfs-tmp"},"user_claim_count":0}]}},"schema":{"$ref":"#/definitions/ListPersistentStorageResp"}},"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":"查询WKS存储","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","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":"name","origin":"request","value":"name"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":2,"x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages?storage_id=94b8e5c7-008f-40d7-b59a-084de3638286","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":"查询WKS存储","tags":"存储管理","uri":null,"version":"2.0"}