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"}}},"ImageJobInfo":{"properties":{"begin_time":{"description":"任务创建时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"end_time":{"description":"任务结束时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"任务ID。","example":"1","readOnly":true,"type":"string"},"job_type":{"$ref":"#/definitions/ImageJobType","description":"任务类型。","readOnly":true},"status":{"$ref":"#/definitions/ImageJobStatus","readOnly":true},"sub_jobs_total":{"description":"子任务总数。","example":10,"readOnly":true,"type":"integer"}}},"ImageJobStatus":{"description":"job状态。\n* `WAITING` - 等待\n* `RUNNING` - 运行中\n* `SUCCESS - 完成\n* `FAILED` - 失败","enum":["WAITING","RUNNING","SUCCESS","FAILED"],"example":"WAITING","type":"string"},"ImageJobType":{"description":"job类型。\n* `CREATE_SERVER` - 创建镜像实例\n* `CREATE_SERVER_IMAGE` - 构建镜像\n* `DELETE_SERVER` - 删除镜像实例","enum":["CREATE_SERVER","CREATE_SERVER_IMAGE","DELETE_SERVER","BUILD_IMAGE","GENERATE_IMAGE","DELETE_IMAGE_BUILD_SERVER","DELETE_IMAGE"],"example":"CREATE_SERVER","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"}}},"ListImageJobResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"任务信息列表,返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/ImageJobInfo"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"}],"description":"查询任务信息列表。"},"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"}}},"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":"3b82a8bc34f44fda8d654a204cdf7fc3","info_version":"v1","method":"get","name":"ListImageJobs","parameters":{},"paths":{"/v1/{project_id}/image-server-jobs":{"get":{"description":"该接口用于查询租户的异步任务执行情况。","operationId":"ListImageJobs","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-is-registered":"N"},{"description":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"job状态:\n* `WAITING` - 等待\n* `RUNNING` - 运行中\n* `SUCCESS` - 完成\n* `FAILED` - 失败","in":"query","name":"status","pattern":"^(WAITING|RUNNING|SUCCESS|FAILED)?$","required":false,"type":"string"},{"description":"job类型:\n* `CREATE_SERVER` - 创建镜像实例\n* `CREATE_SERVER_IMAGE` - 构建镜像\n* `DELETE_SERVER` - 删除镜像实例","in":"query","name":"job_type","pattern":"^(CREATE_SERVER|CREATE_SERVER_IMAGE|DELETE_SERVER)?$","required":true,"type":"string"},{"default":0,"description":"查询的偏移量,默认值0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"查询的数量,值区间[1-100],默认值10。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":0,"items":[{"begin_time":"2022-03-07T10:40:43.858Z","end_time":"2022-03-07T10:40:43.858Z","id":"1","job_type":"createServer","status":"WAITING","sub_jobs_total":10}]}},"schema":{"$ref":"#/definitions/ListImageJobResp"}},"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"}}},"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询租户的镜像任务列表","tags":["Job"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"get","name":"wks-imagemanager-lb","path":"/v1/{project_id}/image-server-jobs","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":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"},{"description":"","in":"query","name":"status","origin":"request","value":"status"},{"description":"","in":"query","name":"job_type","origin":"request","value":"job_type"}],"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":"N","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"}