huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

{"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"}}},"ImageAccountInfo":{"description":"用户详细信息。","properties":{"account":{"description":"用户(组)。","example":"zhangsan***@test.com","maxLength":128,"minLength":1,"type":"string"},"account_type":{"description":"用户类型:\n* `USER` - 用户\n* `USER_GROUP` - 用户组","enum":["USER","USER_GROUP"],"example":"USER_GROUP","type":"string"},"domain":{"description":"域名称。","example":"siv.***.huawei.com","maxLength":64,"minLength":0,"type":"string"}},"required":["account","account_type"],"type":"object"},"ImageRef":{"description":"镜像源信息。","properties":{"id":{"description":"镜像源的唯一标识。","example":"1","maxLength":128,"minLength":1,"type":"string"},"image_type":{"description":"镜像源的镜像类型:\n* `gold` - 云市场镜像\n* `public` - 公共镜像\n* `private` - 私有镜像\n* `shared` - 共享镜像\n* `other` - 其他","enum":["gold","public","private","shared","other"],"example":"private","type":"string"},"product_id":{"default":"","description":"镜像源的产品ID,对于`gold`镜像类型,这个值是的必须项。","example":"00301-1238008-0--0","pattern":"^\\S{0,100}$","type":"string"},"spce_code":{"default":"","description":"镜像源的规格编码,对于`gold`镜像类型,这个值是的必须项。","example":"78b3e72878a81a9b3bfd2b3c912c0f58","pattern":"^\\S{0,100}$","type":"string"}},"required":["id","image_type"],"type":"object"},"ImageServer":{"properties":{"app_group_id":{"description":"应用组ID。","example":"xxx-xxx-xxx-xx","readOnly":true,"type":"string"},"authorize_accounts":{"description":"应用组授权用户,\n* 限制用户类型:'USER' - 用户","items":{"$ref":"#/definitions/ImageAccountInfo"},"maxItems":1,"minItems":1,"type":"array"},"create_time":{"description":"镜像实例创建时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"描述。","example":"测试镜像实例","readOnly":true,"type":"string"},"enterprise_project_id":{"description":"企业项目ID,仅企业项目需配置(字段为空或者0表示使用默认default企业项目)。","example":"xxx-xxx-xx-x-x-xx","maxLength":128,"minLength":0,"type":"string"},"id":{"description":"实例的唯一标识。","example":"222xx-xxxsdfsadf-xxx","readOnly":true,"type":"string"},"image_id":{"description":"镜像产物唯一标识。","example":"xxx-xxx-xxx-xx","readOnly":true,"type":"string"},"image_ref":{"$ref":"#/definitions/ImageRef"},"instance_id":{"description":"ECS服务器ID。","example":"cc5279d6-xxxx-xx-xxx-b87a97cf02af","readOnly":true,"type":"string"},"name":{"description":"镜像实例名称。","example":"测试镜像实例","readOnly":true,"type":"string"},"server_group_id":{"description":"APS服务器组ID。","example":"xxx-xxx-xxx-xx","readOnly":true,"type":"string"},"server_id":{"description":"APS实例ID。","example":"xxx-xxx-xxx-xx","readOnly":true,"type":"string"},"status":{"$ref":"#/definitions/ImageServerStatus"},"update_time":{"description":"更新时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"}}},"ImageServerStatus":{"description":"镜像实例的状态:\n* 'CREATING' - 实例创建中\n* 'ACTIVE' - 实例正常运行\n* 'BUILDING' - 镜像创建中\n* 'BUILT' - 镜像任务结束\n* 'ERROR' - 实例处于异常\n* 'DELETING' - 实例删除中\n* 'NULL' - 未设置","enum":["CREATING","ACTIVE","BUILDING","BUILT","ERROR","DELETING","null"],"example":"BUILDING","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"}}},"ListImageServerResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"镜像实例列表返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/ImageServer"},"readOnly":true,"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":"fd060cbd1b154e84b86c4850da5453a3","info_version":"v1","method":"get","name":"ListImageServers","parameters":{},"paths":{"/v1/{project_id}/image-servers":{"get":{"description":"查询镜像实例列表。","operationId":"ListImageServers","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"},{"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"},{"description":"镜像实例名称,支持部分匹配。","in":"query","maxLength":1024,"minLength":0,"name":"server_name","required":false,"type":"string"},{"description":"镜像实例唯一标识。","in":"query","maxLength":128,"minLength":0,"name":"server_id","required":false,"type":"string","x-example":"xxx-xxx-xxx-xxx-xxxx"},{"description":"企业项目ID(字段为空或者0表示使用默认default企业项目)。","in":"query","maxLength":128,"minLength":0,"name":"enterprise_project_id","required":false,"type":"string","x-example":0}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":2,"items":[{"app_group_id":"","authorize_accounts":[{"account":"user0012","account_type":"USER"}],"create_time":"2024-05-07T07:54:21.009Z","description":"A test of creating an image instance.","enterprise_project_id":"0","id":"697612196993040384","image_id":"","image_ref":{"id":"da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c","image_type":"gold","product_id":"","spce_code":"90a6e84bb3e822fe54999b6be5bbae1e"},"instance_id":"","name":"test_instance_1","server_group_id":"dae99966-76c4-4995-adaf-e8e2ab36869a","server_id":"","status":"CREATING","update_time":"2024-05-07T07:54:22.329Z"},{"app_group_id":"627991243116249088","authorize_accounts":[{"account":"user001","account_type":"USER"}],"create_time":"2023-10-28T04:58:34.058Z","description":"","enterprise_project_id":"0","id":"627989489700044800","image_id":"","image_ref":{"id":"da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c","image_type":"gold","product_id":"","spce_code":"90a6e84bb3e822fe54999b6be5bbae1e"},"instance_id":"989e6391-43b5-49a7-a684-6c36e7ad714a","name":"test_instance_2","server_group_id":"898dda82-4d61-4c3d-bff2-679e61cd34f3","server_id":"wksapp-08722b58-6900-4c03-bfc0-99e1a056b8ad","status":"ACTIVE","update_time":"2023-10-28T05:05:33.826Z"}]}},"schema":{"$ref":"#/definitions/ListImageServerResp"}},"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":["ImageServer"],"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-servers","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":"server_name","origin":"request","value":"server_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-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/image-servers?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"}