huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AppServer":{"allOf":[{"$ref":"#/definitions/BaseServer"},{"properties":{"enterprise_project_id":{"description":"企业项目ID,仅企业项目会返回。","example":"0","readOnly":true,"type":"string"},"freeze":{"description":"冻结信息。","items":{"$ref":"#/definitions/CbcFreezeInfo"},"readOnly":true,"type":"array"},"host_address":{"description":"vpc和子网信息。","items":{"$ref":"#/definitions/EcsNetWork"},"readOnly":true,"type":"array"},"metadata":{"additionalProperties":{"readOnly":true,"type":"string"},"description":"弹性云服务器元数据。\n\n> \n\n1. charging_mode\n云服务器的计费类型。\n\n- “0”:按需计费(即postPaid-后付费方式)。\n- “1”:按包年包月计费(即prePaid-预付费方式)。\"2\":竞价实例计费\n\n2. metering.order_id\n按“包年/包月”计费的云服务器对应的订单ID。\n\n3. metering.product_id\n按“包年/包月”计费的云服务器对应的产品ID。\n\n4. vpc_id\n云服务器所属的虚拟私有云ID。\n\n5. EcmResStatus\n云服务器的冻结状态。\n\n- normal:云服务器正常状态(未被冻结)。\n- freeze:云服务器被冻结。\n\n> 当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。\n\n6. metering.image_id\n云服务器操作系统对应的镜像ID\n\n7.  metering.imagetype\n镜像类型,目前支持:\n\n- 公共镜像(gold)\n- 私有镜像(private)\n- 共享镜像(shared)\n\n8. metering.resourcespeccode\n云服务器对应的资源规格。\n\n9. image_name\n云服务器操作系统对应的镜像名称。\n\n10. os_bit\n操作系统位数,一般取值为“32”或者“64”。\n\n11. lockCheckEndpoint\n回调URL,用于检查弹性云服务器的加锁是否有效。\n\n- 如果有效,则云服务器保持锁定状态。\n- 如果无效,解除锁定状态,删除失效的锁。\n\n12. lockSource\n弹性云服务器来自哪个服务。订单加锁(ORDER)\n\n13. lockSourceId\n弹性云服务器的加锁来自哪个ID。lockSource为“ORDER”时,lockSourceId为订单ID。\n\n14. lockScene\n弹性云服务器的加锁类型。\n\n- 按需转包周期(TO_PERIOD_LOCK)\n\n15. virtual_env_type\n\n- IOS镜像创建虚拟机,\"virtual_env_type\": \"IsoImage\" 属性;\n- 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回\"virtual_env_type\": \"FusionCompute\"属性 。\n\n> virtual_env_type属性不允许用户增加、删除和修改。\n\n16. metering.resourcetype\n云服务器对应的资源类型。\n\n17. os_type\n操作系统类型,取值为:Linux、Windows。\n\n18. cascaded.instance_extrainfo\n系统内部虚拟机扩展信息。\n\n19. __support_agent_list\n云服务器是否支持企业主机安全、主机监控。\n\n- “hss”:企业主机安全\n-  “ces”:主机监控\n\n20. agency_name\n委托的名称。\n\n委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。","example":"charging_mode:0","readOnly":true,"type":"object"},"product_info":{"$ref":"#/definitions/ProductInfo","description":"产品信息。"},"server_group_name":{"description":"服务器组名称。","example":"APS测试服务器组","readOnly":true,"type":"string"},"session_count":{"description":"会话数量。","example":10,"readOnly":true,"type":"integer"},"tags":{"description":"标签信息。","items":{"$ref":"#/definitions/TmsTag"},"type":"array"},"task_status":{"$ref":"#/definitions/AppServerTaskStatus","description":"服务器任务状态(如果当前是稳态,无任务进行中字段可能为null)。","readOnly":true},"vm_status":{"$ref":"#/definitions/AppServerStatus","description":"服务器状态(如果当前是非稳态,存在任务进行中字段可能为null)。","readOnly":true}},"type":"object"}]},"AppServerStatus":{"description":"服务器的稳态,完成某个操作的稳定状态。\n* `BUILD` - 创建APS实例,APS实例进入运行之前的状态\n* `BUILD_FAIL` - 创建APS实例失败\n* `REBOOT` - 实例正在进行重启操作\n* `HARD_REBOOT` - 实例正在进行强制重启操作\n* `REBUILD` - 实例正在重建中\n* `REBUILD_FAIL` - 实例重建失败\n* `MIGRATING` - 实例正在热迁移中\n* `RESIZE` - 实例接收变更请求,开始进行变更操作\n* `ACTIVE` - 实例正常运行状态\n* `SHUTOFF` - 实例被正常停止\n* `REVERT_RESIZE` - 实例正在回退变更规格的配置\n* `VERIFY_RESIZE` - 实例正在校验变更完成后的配置。\n* `ERROR` - 实例处于异常状态。\n* `DELETING` - 实例删除中。\n* `FREEZE` - 冻结\n* `BUILD_IMAGE` - 生成镜像中\n* `BUILD_SNAPSHOT` - 生成快照中\n* `RESTORE_SNAPSHOT` - 恢复快照中\n* `NULL` - 未设置","enum":["BUILD","BUILD_FAIL","REBOOT","HARD_REBOOT","REBUILD","REBUILD_FAIL","MIGRATING","RESIZE","ACTIVE","SHUTOFF","REVERT_RESIZE","VERIFY_RESIZE","ERROR","DELETING","FREEZE","BUILD_IMAGE","BUILD_SNAPSHOT","RESTORE_SNAPSHOT","null"],"example":"BUILD","type":"string"},"AppServerTaskStatus":{"description":"server的任务状态:\n* `scheduling` - 实例处于创建中,正在进行调度\n* `block_device_mapping` - 实例处于创建中,正在准备磁盘\n* `networking` - 实例处于创建中,正在准备网络\n* `spawning` - 实例处于创建中,正在内部创建\n* `rebooting` - 实例处于重启中\n* `reboot_pending` - 实例处于重启中,正在下发重启。\n* `reboot_started` - 实例处于重启中,开始内部重启\n* `rebooting_hard` - 实例处于强制重启中\n* `reboot_pending_hard` - 实例处于强制重启中,正在下发重启\n* `reboot_started_hard` - 实例处于强制重启中,开始内部重启。\n* `rebuilding` - 实例处于重建中。\n* `rebuild_fail` - 实例重建失败。\n* `updating_tsvi` - 实例处于虚拟会话IP更新中。\n* `updating_tsvi_failed` - 实例虚拟会话IP更新失败。\n* `rebuild_block_device_mapping` - 实例处于重建中,正在准备磁盘。\n* `rebuild_spawning` - 实例处于重建中,正在内部重建。\n* `migrating` - 实例处于热迁移中。\n* `resize_prep` - 实例处于调整规格中,正在准备阶段。\n* `resize_migrating` - 实例处于调整规格中,正在迁移阶段。\n* `resize_migrated` - 实例处于调整规格中,已经完成迁移。\n* `resize_finish` - 实例处于调整规格中,正在完成调整。\n* `resize_reverting` - 实例处于调整规格中,正在回退调整。\n* `powering-off` - 实例处于停止中。\n* `powering-on` - 实例处于启动中。\n* `deleting` - 实例处于删除中。\n* `source_locking` - 资源锁定中\n* `rejoining_domain` - 实例正在重新加域\n* `delete_failed` - 实例删除失败\n* `upgrading_access_agent` - 实例正在升级AccessAgent\n* `upgrad_access_agent_fail` - 实例升级AccessAgent失败\n* `upgrad_access_agent_success` - 实例升级AccessAgent成功\n* `updating_sid` - 实例处于创建中,等待更新SID\n* `migrate_failed` - 实例迁移失败\n* `build_image` - 生成镜像中\n* `build_snapshot` - 生成快照中\n* `restore_snapshot` - 恢复快照中\n* `installing_app` - 静默安装app中\n* `install_app_failed` - 安装app失败\n* `null` - 未设置","enum":["scheduling","block_device_mapping","networking","spawning","rebooting","reboot_pending","rebooting_hard","reboot_pending_hard","reboot_started_hard","rebuilding","rebuild_fail","updating_tsvi","updating_tsvi_failed","rebuild_block_device_mapping","rebuild_spawning","migrating","resize_prep","resize_migrating","resize_migrated","resize_finish","resize_reverting","powering-off","powering-on","deleting","rejoining_domain","source_locking","delete_failed","updating_sid","upgrading_access_agent","upgrad_access_agent_fail","upgrad_access_agent_success","migrate_failed","build_image","build_snapshot","restore_snapshot","installing_app","install_app_failed","null"],"example":"scheduling","type":"string"},"BaseServer":{"properties":{"availability_zone":{"description":"服务器可用分区。","example":"","readOnly":true,"type":"string"},"create_time":{"description":"服务器创建时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"描述。","example":"测试服务器","readOnly":true,"type":"string"},"domain":{"description":"域。","example":"china.test.com","readOnly":true,"type":"string"},"flavor":{"$ref":"#/definitions/Flavor","description":"服务器规格详情。"},"host_id":{"description":"云专属主机id。","example":"cc5279d6-xxxx-xx-xxx-b87a97cf02af","readOnly":true,"type":"string"},"id":{"description":"aps实例的唯一标识。","example":"222xx-xxxsdfsadf-xxx","readOnly":true,"type":"string"},"image_id":{"description":"镜像ID。","example":"xxx-xxx-xxx-xx","readOnly":true,"type":"string"},"instance_id":{"description":"实例的ID。","example":"cc5279d6-xxxx-xx-xxx-b87a97cf02af","readOnly":true,"type":"string"},"job_id":{"description":"上一次执行job的id。","example":"437415807337627690","readOnly":true,"type":"string"},"job_status":{"$ref":"#/definitions/JobStatus","description":"上一次执行job的执行结果。","readOnly":true},"job_time":{"description":"上一次执行job的执行时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"job_type":{"$ref":"#/definitions/JobType","description":"上一次执行job的任务类型。","readOnly":true},"machine_name":{"description":"计算机名称。","example":"testy-xxxxx01-china.test.com","readOnly":true,"type":"string"},"maintain_status":{"default":false,"description":"是否维护状态。","example":false,"readOnly":true,"type":"boolean"},"name":{"description":"服务器名称。","example":"测试服务器","readOnly":true,"type":"string"},"order_id":{"description":"包周期产品的订单ID。","example":"sdf2312-dfxxxx-sdfasdf-xxss","readOnly":true,"type":"string"},"os_type":{"description":"操作系统类型,当前仅支持Windows:\n- Linux\n- Windows\n- Other","example":"Windows","readOnly":true,"type":"string"},"os_version":{"description":"服务器系统版本。","example":"","readOnly":true,"type":"string"},"ou_name":{"default":"","description":"组织名称。","example":"wksappusers","readOnly":true,"type":"string"},"resource_pool_id":{"description":"资源池ID。","example":"cc5279d6-xxxx-xx-xxx-b87a97cf02af","readOnly":true,"type":"string"},"resource_pool_type":{"description":"资源池类型:\n- private:私有资源池。\n- public: 工作资源池。","example":"public","readOnly":true,"type":"string"},"scaling_auto_create":{"default":false,"description":"配置弹性伸缩策略时,服务自动创建的实例。\n- true : 通过弹性伸缩创建。\n- false: 不是通过弹性伸缩创建。","example":false,"readOnly":true,"type":"boolean"},"server_group_id":{"description":"服务器组ID。","example":"11111xx-xxxsdfsadf-xxxxxxx","readOnly":true,"type":"string"},"sid":{"description":"实例的SID。","example":"cc5279d6-xxxx-xx-xxx-b87a97cf02af","readOnly":true,"type":"string"},"status":{"$ref":"#/definitions/ServerStatus"},"update_time":{"description":"更新时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"}}},"CbcFreezeInfo":{"properties":{"effect":{"default":1,"description":"在冻结/解冻等操作下,云服务需要达到的主要效果:\n\n- 1:(实现/去除)冻结可释放。(资源冻结后,客户可以手动删除/释放云资源和云资源上数据。)\n\n- 2:(实现/去除)冻结不可释放。(资源冻结后,客户不能手动删除/释放云资源以及云资源上数据,相当于云服务被贴了封条,不能改变数据和资源。对应解冻后,就可以删除和修改客户数据了。)\n\n- 3:(实现/去除)冻结后不可续费。(资源冻结后,资源不能发起续费操作;解冻后,才可以发起续费操作。)\n\n- effect字段和上面status字段(1冻结、0解冻)配合使用,表示在发起冻结/解冻命令下,云服务达到的冻结效果。\n\n- 为空时,默认为effect=1(云服务需要能兼容处理,默认当做effect=1)。\n\n- 注:云服务是根据status和effect在真实限制云服务的操作/API等。不是使用下文的scene字段去做云服务操作/API的限制。下文的scene字段,主要用于Console页面的tips、API错误码等客户体验使用。","example":1,"format":"int32","maximum":3,"minimum":1,"type":"integer"},"scene":{"$ref":"#/definitions/CbcFreezeScene"}}},"CbcFreezeScene":{"default":"ARREAR","description":"更新云服务状态的业务场景,默认`ARREAR`。 * `ARREAR` - 欠费场景;为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。 * `POLICE` - 公安冻结场景。 * `ILLEGAL` - 违规冻结场景。 * `VERIFY` - 客户未实名认证冻结场景。 * `PARTNER` - 合作伙伴冻结(合作伙伴冻结子客户资源)。","enum":["ARREAR","POLICE","ILLEGAL","VERIFY","PARTNER"],"example":"ARREAR","type":"string"},"EcsNetWork":{"allOf":[{"$ref":"#/definitions/ServerAddressNetWork"},{"properties":{"subnet_id":{"description":"子网id。","example":"0785eeba-bfbb-4da3-94f9-d311c792e875","readOnly":true,"type":"string"},"tenant_type":{"description":"租户类别:\n- tenant: 租户\n- resource_tenant: 资源租户","example":"tenant","readOnly":true,"type":"string"},"vpc_id":{"description":"虚拟私有云ID。","example":"3bb2b656-0b79-4975-b870-a407f19038bb","readOnly":true,"type":"string"}},"type":"object"}],"description":"服务器网络信息。"},"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"}}},"Flavor":{"properties":{"id":{"description":"服务器对应的规格ID。","example":"asdfjkl-2131f-xxx-123123","readOnly":true,"type":"string"},"links":{"description":"服务器对应规格的相关标记快捷链接信息。","items":{"$ref":"#/definitions/FlavorLink"},"readOnly":true,"type":"array"}}},"FlavorLink":{"properties":{"hrel":{"description":"对应快捷链接。","example":"","readOnly":true,"type":"string"},"rel":{"description":"快捷链接标记名称。","example":"","readOnly":true,"type":"string"}}},"JobStatus":{"description":"job状态\n* `WAITING` - 等待\n* `RUNNING` - 运行中\n* `SUCCESS` - 完成\n* `FAILED` - 失败","enum":["WAITING","RUNNING","SUCCESS","FAILED"],"example":"WAITING","type":"string"},"JobType":{"description":"job类型:\n* `CREATE_SERVER` - 创建服务器\n* `DELETE_SERVER` - 删除服务器\n* `UPDATE_FREEZE_STATUS` - 修改服务器冻结状态\n* `CREATE_SERVER_IMAGE` - 构建镜像\n* `REINSTALL_OS` - 重装操作系统\n* `CHANGE_SERVER_IMAGE` - 更换镜像\n* `REJOIN_DOMAIN` - 重新加域\n* `MIGRATE_SERVER` - 迁移服务器\n* `UPGRADE_ACCESS_AGENT` - hda升级\n* `UPDATE_SERVER_TSVI` - 更新虚拟会话IP\n* `SCHEDULED_TASK` - 定时任务job\n* `COLLECT_HDA_LOG` - 收集hda日志\n* `COLLECT_APS_LOG` - 收集aps日志\n* `CREATE_SERVER_SNAPSHOT` - 创建服务器快照\n* `DELETE_SERVER_SNAPSHOT` - 删除服务器快照\n* `RESTORE_SERVER_SNAPSHOT` - 恢复服务器快照\n* `BATCH_INSTALL_APP` - 批量安装应用","enum":["CREATE_SERVER","DELETE_SERVER","UPDATE_FREEZE_STATUS","CREATE_SERVER_IMAGE","REINSTALL_OS","CHANGE_SERVER_IMAGE","REJOIN_DOMAIN","MIGRATE_SERVER","UPGRADE_ACCESS_AGENT","UPDATE_SERVER_TSVI","SCHEDULED_TASK","COLLECT_HDA_LOG","COLLECT_APS_LOG","CREATE_SERVER_SNAPSHOT","DELETE_SERVER_SNAPSHOT","RESTORE_SERVER_SNAPSHOT","BATCH_INSTALL_APP"],"example":"CREATE_SERVER","type":"string"},"ListServerResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"服务器列表返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/AppServer"},"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"}}},"ProductInfo":{"properties":{"architecture":{"description":"产品架构,当前仅支持x86。\n- x86\n- arm","example":"x86","maxLength":255,"minLength":1,"type":"string"},"charge_mode":{"description":"套餐标识。\n- 1:表示包周期。\n- 0:表示按需。","maxLength":1,"minLength":0,"type":"string"},"cloud_service_type":{"description":"云服务类型。","example":"hws.service.type.xxxxx","maxLength":255,"minLength":0,"type":"string"},"cond_operation_az":{"description":"产品套餐在可用区的状态,配套status使用。\n> - 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。\n> - 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。\n> - 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为:\n>   - “status”设置为:“abandon” 。\n>   - “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。 \n> -  说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。","example":"cn-north-5a(normal),cn-north-5b(abandon),cn-north-5c(sellout)","minLength":0,"type":"string"},"contain_data_disk":{"description":"套餐计费是否包含了数据盘。","example":false,"type":"boolean"},"cpu":{"description":"CPU。","example":"2","maxLength":255,"minLength":1,"type":"string"},"cpu_desc":{"description":"CPU描述。","example":"云应用通用型|4核|8GB内存","maxLength":255,"minLength":0,"type":"string"},"descriptions":{"description":"产品描述。","example":"GPU图形加速DG4型|32核128G内存32G显存|P02","maxLength":255,"minLength":1,"type":"string"},"domain_ids":{"description":"产品属于专有的domainId。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"expire_time":{"description":"产品套餐过期时间,产品将在改时间点后逐步下架。","example":"2022-03-07T10:40:43Z","format":"date-time","readOnly":true,"type":"string"},"flavor_id":{"description":"规格ID。","example":"c3.large.4","maxLength":255,"minLength":1,"type":"string"},"gpu_desc":{"description":"GPU描述。","example":"GPU图形加速","maxLength":255,"minLength":0,"type":"string"},"is_gpu":{"description":"是否是GPU类型的规格。","example":false,"type":"boolean"},"memory":{"description":"内存大小,单位兆:MB。","example":"4096","maxLength":255,"minLength":1,"type":"string"},"package_type":{"description":"套餐类型:\n- general:表示产品通用套餐。\n- dedicated:表示产品专属主机套餐。","example":"general","maxLength":64,"minLength":0,"type":"string"},"product_id":{"description":"产品id。","example":"workspace.appstream.general.2xlarge.4","maxLength":128,"minLength":1,"type":"string"},"resource_type":{"description":"资源类型。","example":"hws.resource.type.xxxx.vm","maxLength":255,"minLength":0,"type":"string"},"series_type":{"description":"系列类型。","example":"c6","maxLength":64,"minLength":0,"type":"string"},"sessions":{"description":"套餐默认支持的最大会话数。","example":2,"readOnly":true,"type":"integer"},"status":{"description":"产品套餐在销售模式下的状态,取值自ECS的cond:operation:status。\n不配置时等同于normal在售状态。\n* `normal` - 正常商用\n* `abandon` - 下线(即不显示)\n* `sellout` - 售罄\n* `obt` - 公测\n* `obt_sellout` - 公测售罄\n* `promotion` - 推荐(等同normal,也是商用)","maxLength":16,"minLength":0,"type":"string"},"sub_product_list":{"description":"专属主机的子产品。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"support_gpu_type":{"description":"产品套餐支持的GPU类型。","example":"A40","format":"支持的GPU类型","readOnly":true,"type":"string"},"system_disk_size":{"default":"80","description":"系统盘大小。","example":"80","maxLength":10,"minLength":0,"type":"string"},"system_disk_type":{"default":"SAS","description":"系统盘类型。","example":"SAS","maxLength":32,"minLength":0,"type":"string"},"type":{"description":"产品类型。\n- BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。\n- ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。","example":"BASE","maxLength":55,"minLength":1,"type":"string"},"volume_product_type":{"description":"磁盘产品类型。","example":"workspace","maxLength":255,"minLength":0,"type":"string"}},"type":"object"},"ServerAddressNetWork":{"properties":{"OS-EXT-IPS-MAC:mac_addr":{"description":"MAC地址。","example":"C8-XX-XX-XX-XX-57","readOnly":true,"type":"string"},"OS-EXT-IPS:port_id":{"description":"IP地址对应的端口ID。","example":"4b5fe243-2f5f-4c68-9eb2-8af3a5366666","readOnly":true,"type":"string"},"OS-EXT-IPS:type":{"description":"IP地址分配方式,字符串是大小写不敏感格式。\n* `fixed` - 代表私有IP地址。\n* `floating` - 代表浮动IP地址。","example":"fixed","readOnly":true,"type":"string"},"addr":{"description":"IP地址信息。","example":"127.*.*.1","readOnly":true,"type":"string"},"version":{"description":"IP地址类型:\n`4` - IPV4\n`6` - IPV6","example":4,"readOnly":true,"type":"integer"}}},"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"},"TmsTag":{"description":"tms标签。","properties":{"key":{"description":"键。最大长度128个unicode字符。\n1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @\n2. 两头不能有空白字符","example":"demo01","pattern":"^((?!_sys_)[\\p{L}\\p{Z}\\p{N}_.:=+\\-@]{1,128})(?<!\\s)$","type":"string"},"value":{"description":"值。每个值最大长度255个unicode字符。\n1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @","example":"01","pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]{0,255})$","type":"string"}},"required":["key"]}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"60eade0a91f64589b86c7f4bcd912618","info_version":"v1","method":"get","name":"ListServers","parameters":{},"paths":{"/v1/{project_id}/app-servers":{"get":{"description":"查询服务器列表。","operationId":"ListServers","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":"服务器组唯一标识。","in":"query","maxLength":128,"minLength":1,"name":"server_group_id","required":false,"type":"string","x-example":"1c873056-9f4d-11ec-b909-0242ac120002"},{"description":"服务器名称,支持部分匹配。","in":"query","maxLength":1024,"minLength":0,"name":"server_name","required":false,"type":"string"},{"description":"机器名称,支持部分匹配。","in":"query","maxLength":1024,"minLength":0,"name":"machine_name","required":false,"type":"string"},{"description":"ip地址,支持部分匹配。","in":"query","maxLength":64,"minLength":0,"name":"ip_addr","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":"服务器维护状态:\n- true : 维护态的实例。\n- false: 非维护态的实例。","in":"query","name":"maintain_status","pattern":"^(true|false)$","required":false,"type":"string","x-example":false},{"description":"是否是弹性创建:\ntrue : 通过弹性伸缩创建。\nfalse: 不是通过弹性伸缩创建。","in":"query","name":"scaling_auto_create","pattern":"^(true|false)$","required":false,"type":"string","x-example":false}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":1,"items":[{"availability_zone":"cn-north-7a","create_time":"2023-05-09T10:28:38.755Z","description":"","domain":"wksapp***.huawei.com","flavor":{"id":"s2.large.2","links":[{"rel":"self"},{"rel":"bookmark"}]},"freeze":[],"host_address":[{"OS-EXT-IPS-MAC:mac_addr":"fa:16:**:**:75:06","OS-EXT-IPS:port_id":"257f2ff5-fe85-4b9a-86c2-5dacb64ac78f","OS-EXT-IPS:type":"FIXED","addr":"192.*.*.145","subnet_id":"a5842cb4-5718-4b0a-8b27-3a3e9c74f977","tenant_type":"tenant","version":4,"vpc_id":"59785ba5-e5d5-4836-b9de-19f22ac15175"},{"OS-EXT-IPS-MAC:mac_addr":"fa:16:**:**:02:88","OS-EXT-IPS:port_id":"c6fc6fcc-c99e-4604-b0e0-04e48246c7cd","OS-EXT-IPS:type":"FIXED","addr":"10.*.*.79","subnet_id":"e851a83c-8696-48ea-b078-466fe9d361ae","tenant_type":"resource_tenant","version":4,"vpc_id":"82f75215-9ae6-4e69-882c-fe4088324839"}],"id":"573548db-9a6f-4b31-a5cb-d7aa40975466","image_id":"ca8be629-112e-4865-b4fb-bbbca257f1d9","instance_id":"4fa75b74-56bc-4a6b-b965-f2f139e17b5e","machine_name":"APS-PR6KRMAL00","maintain_status":false,"metadata":{"charging_mode":"0","metering.resourcespeccode":"s2.large.2.win","metering.resourcetype":"1"},"name":"APS-20230509102837-IVTU6S27OY","order_id":"","os_type":"Windows","os_version":"Windows Server 2019 Datacenter 64bit","ou_name":"","product_info":{"architecture":"x86","charge_mode":"0","cloud_service_type":"hws.service.type.vdi","contain_data_disk":false,"cpu":"2","descriptions":"s2.large.2 云应用通用型|2核|4GB内存","flavor_id":"s2.large.2","is_gpu":false,"memory":"4096","product_id":"workspace.appstream.general.xlarge.2","resource_type":"hws.resource.type.workspace.appstream","sessions":1,"status":"abandon","system_disk_size":"80","system_disk_type":"SAS","type":"BASE","volume_product_type":"workspace"},"resource_pool_id":"10dd1a4f-ff85-4953-aa0f-2a37f28b6beb","resource_pool_type":"private","scaling_auto_create":false,"server_group_id":"a0890780-7ef2-4aaf-b56d-b25fb53b717e","server_group_name":"Nas","session_count":1,"sid":"S-1-5-21-1213649063-4191095369-2401105760-1399","status":"REGISTERED","task_status":"null","update_time":"2023-05-09T10:39:03.484Z","vm_status":"ACTIVE"}]}},"schema":{"$ref":"#/definitions/ListServerResp"}},"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":["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","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"},{"description":"","in":"query","name":"server_group_id","origin":"request","value":"server_group_id"},{"description":"","in":"query","name":"maintain_status","origin":"request","value":"maintain_status"},{"description":"","in":"query","name":"scaling_auto_create","origin":"request","value":"scaling_auto_create"}],"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-order":2,"x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers?offset=0&limit=10","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"}