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"}}},"ListFutureExecutionsReq":{"allOf":[{"$ref":"#/definitions/ScheduledTaskConfig"},{"type":"object"}],"description":"获取未来执行的具体时间列表请求体。"},"ListFutureExecutionsResp":{"description":"获取未来执行的具体时间列表响应体。","properties":{"future_executions":{"description":"未来执行的具体时间列表。","items":{"example":"2022-12-23 09:00:00","readOnly":true,"type":"string"},"readOnly":true,"type":"array"},"time_zone":{"description":"时区。","example":"Asia/Shanghai","readOnly":true,"type":"string"}},"type":"object"},"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"}}},"ScheduledTaskConfig":{"description":"定时任务时间配置。","properties":{"date_list":{"description":"周期按月时:取值1~31及L(代表当月最后一天),英文逗号分隔,如1,2,28,L。","example":"1,2,28,L","maxLength":255,"minLength":0,"type":"string"},"day_interval":{"description":"周期按天时:按x天间隔执行。","example":1,"format":"int32","maximum":31,"minimum":1,"type":"integer"},"expire_time":{"description":"到期时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","type":"string"},"month_list":{"description":"周期按月时:取值1~12,英文逗号分隔,如1,3,12。","example":"1,3,12","maxLength":255,"minLength":0,"type":"string"},"scheduled_date":{"description":"周期指定时间时:表示指定的日期,格式为yyyy-MM-dd。","example":"2022-12-23","maxLength":255,"minLength":0,"type":"string"},"scheduled_time":{"description":"指定的执行时间点,格式为HH:mm:ss。","example":"09:00:00","maxLength":255,"minLength":0,"type":"string"},"scheduled_type":{"description":"执行周期类型,可选值为:\n- FIXED_TIME:指定时间。\n- DAY:按天。\n- WEEK:按周。\n- MONTH:按月。","enum":["FIXED_TIME","DAY","WEEK","MONTH"],"example":"FIXED_TIME","type":"string"},"time_zone":{"description":"时区。","example":"Asia/Shanghai","maxLength":64,"minLength":1,"type":"string"},"week_list":{"description":"周期按周时:取值1~7,英文逗号分隔,如1,2,7。","example":"1,2,7","maxLength":255,"minLength":0,"type":"string"}},"type":"object"},"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":"f2997d2cf2a34d75a940be7cb9d5d1af","info_version":"v1","method":"post","name":"ListFutureExecutions","parameters":{},"paths":{"/v1/{project_id}/schedule-task/future-executions":{"post":{"description":"未来执行的具体时间列表。","operationId":"ListFutureExecutions","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..."},{"description":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"未来执行的具体时间列表请求参数。","in":"body","name":"ListFutureExecutionsRequestBody","required":true,"schema":{"$ref":"#/definitions/ListFutureExecutionsReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"future_executions":["string"],"time_zone":"Asia/Shanghai"}},"schema":{"$ref":"#/definitions/ListFutureExecutionsResp"}},"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":["ScheduleTask"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"post","name":"wks-apsmanager-lb","path":"/v1/{project_id}/schedule-task/future-executions","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_get","x-apigateway-request-type":"public","x-is-registered":"N","x-request-examples-1":{"date_list":"1,2,28,L","day_interval":1,"expire_time":"2022-03-07T10:40:43.858Z","month_list":"1,3,12","scheduled_date":"2022-12-23","scheduled_time":"09:00:00","scheduled_type":"FIXED_TIME","time_zone":"Asia/Shanghai","week_list":"1,2,7"},"x-request-examples-text-1":{"date_list":"1,2,28,L","day_interval":1,"expire_time":"2022-03-07T10:40:43.858Z","month_list":"1,3,12","scheduled_date":"2022-12-23","scheduled_time":"09:00:00","scheduled_type":"FIXED_TIME","time_zone":"Asia/Shanghai","week_list":"1,2,7"},"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"}