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"}}},"ListServerHdaDetailsResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/ServerHdaDetails"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询服务器的accessAgent详细信息响应。"},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"ServerHdaDetails":{"description":"服务器的accessAgent详细信息。","properties":{"current_version":{"description":"当前的accessAgent版本。","example":"22.10.0.1020","readOnly":true,"type":"string"},"machine_name":{"description":"机器名称。","example":"APS-DDP9KKUYTR","readOnly":true,"type":"string"},"maintain_status":{"description":"是否是维护状态。","example":true,"readOnly":true,"type":"boolean"},"server_group_id":{"description":"服务器组id。","example":"489533790436196976","readOnly":true,"type":"string"},"server_group_name":{"description":"服务器组名称。","example":"测试使用服务器组","readOnly":true,"type":"string"},"server_id":{"description":"服务器id。","example":"489533790436196976","readOnly":true,"type":"string"},"server_name":{"description":"服务器名称。","example":"APS-20221011032502-DL51DUK113","readOnly":true,"type":"string"},"session_count":{"description":"会话数量。","example":10,"readOnly":true,"type":"integer"},"sid":{"description":"服务器的sid。","example":"489533790436196976","readOnly":true,"type":"string"},"status":{"$ref":"#/definitions/ServerStatus","readOnly":true}}},"ServerStatus":{"description":"实例的状态:\n* `UNREGISTER` - 未就绪\n* `REGISTERED` - 就绪状态\n* `MAINTAINING` - 维护中\n* `FREEZE` - 冻结\n* `STOPPED` - 停止\n* `NONE` - 异常状态","enum":["UNREGISTER","REGISTERED","MAINTAINING","FREEZE","STOPPED","NONE"],"example":"UNREGISTER","type":"string"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"7ad64ec58d084d2dac70d269810bd989","info_version":"v1","method":"get","name":"ListServerHdaDetails","parameters":{},"paths":{"/v1/{project_id}/app-servers/access-agent/list":{"get":{"description":"查询服务器的HDA相关信息。","operationId":"ListServerHdaDetails","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"},{"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":"服务器组id。","in":"query","maxLength":128,"minLength":0,"name":"server_group_id","required":false,"type":"string"},{"description":"服务器名称。","in":"query","maxLength":128,"minLength":0,"name":"server_name","required":false,"type":"string"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":0,"items":[{"current_version":"22.10.0.1020","machine_name":"APS-DDP9KKUYTR","maintain_status":true,"server_group_id":"489533790436196976","server_group_name":"测试使用服务器组","server_id":"489533790436196976","server_name":"APS-20221011032502-DL51DUK113","session_count":10,"sid":"489533790436196976","status":"UNREGISTER"}]}},"schema":{"$ref":"#/definitions/ListServerHdaDetailsResp"}},"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"}},"409":{"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":"查询服务器的HDA相关信息","tags":["Server"],"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}/app-servers/access-agent/list","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":"server_group_id","origin":"request","value":"server_group_id"},{"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":"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":"查询服务器的HDA相关信息","tags":"服务器管理","uri":null,"version":"2.0"}