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":{"ErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00169901","maxLength":16,"minLength":1,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","maxLength":255,"minLength":1,"type":"string"}}},"ListScheduleTaskExecuteHistoryResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"定时任务执行记录列表,返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/ScheduleTaskExecuteHistory"},"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"}}},"ScheduleTaskExecuteHistory":{"description":"定时任务执行记录。","properties":{"begin_time":{"description":"任务开始时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"create_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"},"excuting_count":{"description":"正在执行的子任务数。","example":4,"readOnly":true,"type":"integer"},"failed_count":{"description":"失败的子任务数。","example":4,"readOnly":true,"type":"integer"},"id":{"description":"定时任务执行记录主键id。","example":"62f48b59-0ebb-4b1e-ad35-f64948a0591b","readOnly":true,"type":"string"},"scheduled_type":{"$ref":"#/definitions/ScheduledTypeEnum","description":"定时任务状态。","readOnly":true},"status":{"$ref":"#/definitions/ScheduleTaskStatus","description":"定时任务状态。","readOnly":true},"success_count":{"description":"成功的子任务数。","example":5,"readOnly":true,"type":"integer"},"task_id":{"description":"定时任务主键id。","example":"62f48b59-0ebb-4b1e-ad35-f64948a0591b","readOnly":true,"type":"string"},"task_type":{"$ref":"#/definitions/ScheduleTaskTypeEnum","description":"任务类型。","readOnly":true},"time_zone":{"description":"时区。","example":"Asia/Shanghai","readOnly":true,"type":"string"},"total_count":{"description":"总子任务数。","example":10,"readOnly":true,"type":"integer"}}},"ScheduleTaskStatus":{"description":"job状态:\n* `WAITING` - 等待\n* `RUNNING` - 运行中\n* `SUCCESS` - 完成\n* `FAILED` - 失败","enum":["WAITING","RUNNING","SUCCESS","FAILED"],"example":"WAITING","type":"string"},"ScheduleTaskTypeEnum":{"description":"定时任务类型:\n* `RESTART_SERVER` - 定时重启服务器\n* `START_SERVER` - 定时开机\n* `STOP_SERVER` - 定时关机\n* `REINSTALL_OS` - 定时重装操作系统","enum":["RESTART_SERVER","START_SERVER","STOP_SERVER","REINSTALL_OS"],"example":"RESTART_SERVER","type":"string"},"ScheduledTypeEnum":{"description":"执行周期:\n* `FIXED_TIME` - 指定时间\n* `DAY` - 按天\n* `WEEK` - 按周\n* `MONTH` - 按月","enum":["FIXED_TIME","DAY","WEEK","MONTH"],"example":"day","type":"string"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"6882a03390d6417583572ed7899942aa","info_version":"v1","method":"get","name":"ListTaskExecuteHistory","parameters":{},"paths":{"/v1/{project_id}/schedule-task/{task_id}/execute-history":{"get":{"description":"查询定时任务执行列表。","operationId":"ListTaskExecuteHistory","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":"path","maxLength":128,"minLength":1,"name":"task_id","required":true,"type":"string"},{"default":0,"description":"查询的偏移量。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"查询的数量,值区间[1-100]。","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","create_time":"2022-03-07T10:40:43.858Z","end_time":"2022-03-07T10:40:43.858Z","excuting_count":4,"failed_count":4,"id":"62f48b59-0ebb-4b1e-ad35-f64948a0591b","scheduled_type":"day","status":"WAITING","success_count":5,"task_id":"62f48b59-0ebb-4b1e-ad35-f64948a0591b","task_type":"RESTART_SERVER","time_zone":"Asia/Shanghai","total_count":10}]}},"schema":{"$ref":"#/definitions/ListScheduleTaskExecuteHistoryResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/ErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/ErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ErrorResp"}}},"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":"get","name":"wks-apsmanager-lb","path":"/v1/{project_id}/schedule-task/{task_id}/execute-history","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":"path","name":"task_id","origin":"request","value":"task_id"},{"description":"","in":"query","name":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"}],"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":"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"}