华为云用户手册

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a", "name" : "ApiExpirezSr5_1HgOfh56", "description" : "", "image_id" : "6579b42e-f345-4452-ae3a-fa0687564943", "os_type" : "Windows", "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "is_vdi" : false, "app_type" : "COMMON_APP", "create_time" : "2023-06-06T14:14:36.416Z", "update_time" : "2023-06-06T14:14:38.127Z", "app_server_flavor_count" : 0, "app_server_count" : 0, "app_group_count" : 0, "image_name" : "ApiExplore_Image_01", "product_info" : { "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "s2.large.2", "type" : "BASE", "architecture" : "x86", "cpu" : "2", "memory" : "4096", "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存", "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 1, "status" : "abandon", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(normal)", "domain_ids" : [ ] }, "subnet_name" : "subnet-config", "ou_name" : "" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ServerGroup objects 服务器组列表，返回列表条目数量上限为分页的最大上限值。 表5 ServerGroup 参数 参数类型 描述 id String 服务器组的唯一标识。 name String 服务器组名称。 description String 服务器组描述。 image_id String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - product_id String 产品id。 subnet_id String 网卡对应的子网ID。 system_disk_type String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size Integer 磁盘容量，单位GB。 is_vdi Boolean 是否为vdi单会话模式。 extra_session_type String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size Integer 付费会话个数。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app create_time String 服务器组创建时间 update_time String 服务器组更新时间 storage_mount_policy String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 app_server_flavor_count Integer 服务器配置总数量。 app_server_count Integer 服务器总数量。 app_group_count Integer 关联应用组的总数量。 image_name String 镜像名称。 product_info ProductInfo object 产品规格信息。 subnet_name String 子网名称。 scaling_policy ScalingPolicy object 弹性伸缩策略。 ou_name String 默认组织名称。 表6 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 architecture String 产品架构，当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小，单位兆：M。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1：表示包周期。 0：表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态，取值自E CS 的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线（即不显示） sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal，也是商用) cond_operation_az String 产品套餐在可用区的状态，配套status使用。 说明： 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “status”设置为：“abandon” 。 “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型： general：表示产品通用套餐。 dedicated：表示产品专属主机套餐。 expire_time String 产品套餐过期时间，产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 表7 ScalingPolicy 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表8 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到改阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-server-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_name 否 String 服务器组名称。 server_group_id 否 String 服务器组唯一标识。 app_type 否 String 应用组类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466", "name" : "APS-20230509102837-IVTU6S27OY", "machine_name" : "APS-PR6KRMAL00", "description" : "", "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "flavor" : { "id" : "s2.large.2", "links" : [ { "rel" : "self" }, { "rel" : "bookmark" } ] }, "status" : "REGISTERED", "create_time" : "2023-05-09T10:28:38.755Z", "update_time" : "2023-05-09T10:39:03.484Z", "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9", "availability_zone" : "cn-north-7a", "domain" : "wksapp***.huawei.com", "ou_name" : "", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399", "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e", "os_version" : "Windows Server 2019 Datacenter 64bit", "os_type" : "Windows", "order_id" : "", "maintain_status" : false, "scaling_auto_create" : false, "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb", "resource_pool_type" : "private", "server_group_name" : "Nas", "product_info" : { "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "s2.large.2", "type" : "BASE", "architecture" : "x86", "cpu" : "2", "memory" : "4096", "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存", "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 1, "status" : "abandon" }, "metadata" : { "charging_mode" : "0", "metering.resourcespeccode" : "s2.large.2.win", "metering.resourcetype" : "1" }, "session_count" : 1, "vm_status" : "ACTIVE", "task_status" : "null", "freeze" : [ ], "host_address" : [ { "addr" : "192.*.*.145", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f", "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "tenant_type" : "tenant" }, { "addr" : "10.*.*.79", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd", "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839", "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae", "tenant_type" : "resource_tenant" } ] } ] }

URI GET /v1/{project_id}/app-servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_id 否 String 服务器组唯一标识。 server_name 否 String 服务器名称，支持部分匹配。 server_id 否 String 服务器唯一标识。 maintain_status 否 String 服务器维护状态： true : 维护态的实例。 false: 非维护态的实例。 scaling_auto_create 否 String 是否是弹性创建： true : 通过弹性伸缩创建。 false: 不是通过弹性伸缩创建。

请求示例 { "desktop_type" : "DEDICATED", "image_type" : "gold", "image_id" : "a866298d-67db-44b0-a1f1-9d09bdddc20f", "root_volume" : { "type" : "SAS", "size" : 80 }, "availability_zone" : "az3.manage.x86", "desktops" : [ { "user_name" : "ljh-002", "user_group" : "administrators", "user_email" : "aaaaa@huawei.com" } ], "nics" : [ { "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55" } ], "product_id" : "workspace.c2.large.windows.2", "email_notification" : true }

响应参数 状态码： 200 表10 响应Body参数 参数 参数类型 描述 job_id String 创建 云桌面 总任务id 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 正常 { "desktop" : [ { "desktop_id" : "21616aa6-061d-4b2f-bd83-b230d7a9a14c", "computer_name" : "CHENMIN01", "addresses" : [ { "addr" : "172.16.253.204", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:2e:41:55", "OS-EXT-IPS:type" : "fixed" }, { "addr" : "10.0.9.55", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:d5:b3:02", "OS-EXT-IPS:type" : "fixed" } ], "ip_addresses" : [ "172.16.253.204", "10.0.9.55" ], "desktop_type" : "DEDICATED", "metadata" : { "image_name" : "copy_uos-hjg1", "metering.resourcespeccode" : "rs3.large.2.linux", "charging_mode" : "0", "metering.image_id" : "39efed30-a0db-4520-8134-19a086e14c7e", "metering.resourcetype" : "1", "os_type" : "Linux", "os_bit" : "64", "desktop_os_version" : "20" }, "flavor" : { "id" : "rs3.large.2", "links" : [ ] }, "status" : "ACTIVE", "task_status" : "", "created" : "2022-01-21T06:57:47.459Z", "login_status" : "REGISTERED", "user_name" : "chenmin", "product_id" : "workspace.k.large2.uosv20pro", "share_resource_sku" : "workspace.collaborativedesktop.6party.standard", "root_volume" : { "type" : "SAS", "size" : 90, "device" : "/dev/vda", "id" : "e4406c227a8711ecaf56fa163ed8e03f", "volume_id" : "91b9457c-ef61-4058-9e82-c86b35f15934", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace002" }, "data_volumes" : [ { "type" : "SATA", "size" : 10, "device" : "/dev/vdc", "id" : "fd4597cb80b311ecaf56fa163ed8e03f", "volume_id" : "230432f1-44a4-47a1-862e-cd0b65c04bd1", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace001" } ], "user_group" : "default", "availability_zone" : "cn-north-5a", "product" : { "product_id" : "workspace.k.large2.uosv20pro", "flavor_id" : "rs3.large.2", "type" : "BASE", "cpu" : "2", "memory" : "3072", "descriptions" : "CPU:2vCPUs,Memory:4GB", "charge_mode" : "0" }, "os_version" : "20", "sid" : "1f60adc1-941c-48b8-b5c8-64948329b7cb", "order_id" : "CS2201211457G0PUY", "tags" : [ ] } ] }

响应示例 状态码： 200 正常。 { "policies" : [ { "policy_id" : "8ac225c2781edb0d01781edde3f4xxxx", "create_time" : "2022-10-24T17:24:56.000+00:00", "policy_name" : "PRIVATE_AC CES S", "blacklist_type" : "INTERNET" } ], "total" : 1 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policies Array of AccessPolicyDetailInfo objects 查询接入策略响应。 total Integer 策略总数。 表5 AccessPolicyDetailInfo 参数 参数类型 描述 policy_name String 策略名，当前只支持专线接入策略名。 PRIVATE_ACCESS： 专线接入 blacklist_type String 黑名单类型，当前黑名单只支持互联网。 INTERNET： 互联网 policy_id String 策略id。 create_time String 用户otp设备绑定时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 os_type String 套餐所支持操作系统类型。请求参数有os_type时，才有此参数。 architecture String 产品架构。请求参数有package_type=agile时，才有此参数。 availability_zone String 可用分区。请求参数有availability_zone时，才有此参数。 products Array of ProductInfo objects 产品列表。 total_count Integer 对象总数。 表5 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型。取值为： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 architecture String 产品架构，当前支持：arm、x86。 cpu String cpu。 cpu_desc String cpu描述。 memory String 内存。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小，单位GB。 data_disk_size String 数据盘大小，单位GB。 gpu_desc String GPU描述。 bill_switch String 话单开关，默认on,on-出话单模式,off-关话单模式,只支持反序列化，不支持序列化，不在接口中展示。 descriptions String 产品描述。 charge_mode String 周期套餐标识。0表示包周期，1表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘,off-不包含。 resource_type String 资源规格。 cloud_service_type String 云服务编码。 volume_product_type String 磁盘产品类型。 domain_ids Array of strings 该产品套餐支持的专有域id（domainId）。 status String 产品状态，normal：正常、sellout：售空、abandon：下线。 sub_product_list Array of strings 专属主机的子产品。 default_desktop_num Integer 专享主机套餐默认的桌面数。 max_apply_desktop_num Integer 专享主机支持创建的最大桌面数。 share_space_size Integer 协同方数。该套餐支持的最大协同人数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询产品列表响应。 { "os_type" : "Linux", "availability_zone" : "cn-north-4c", "total_count" : 1, "products" : { "product_id" : "workspace.k.xlarge.2.linux", "flavor_id" : "kc1.xlarge.2", "type" : "BASE", "cpu" : "4", "memory" : "8192", "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "CPU:4vCPUs,Memory:8GB", "architecture" : "arm", "is_gpu" : false, "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.vdi.vm", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "package_type" : "enterprise" } }

URI GET /v2/{project_id}/products 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 产品ID。 availability_zone 否 String 可用分区。 os_type 否 String 产品套餐的操作系统类型，当前支持：Windows、Linux。 charge_mode 否 String 周期套餐标识。0表示包周期，1表示按需。 architecture 否 String 架构类型，当前支持：arm、x86。 deh_product_id 否 String wdh套餐id。 is_deh 否 Boolean 是否为wdh产品。 package_type 否 String 套餐系列。 limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量，默认0。

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 put /v2/0e973a948e8091232f25c00673f168b7/access-policy/20b726affecc4411bcdc49a66e3e8f63/objects { "policy_objects_list" : [ { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" }, { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_objects_list 否 Array of AccessPolicyObjectInfo objects 更新策略应用对象列表请求。 表4 AccessPolicyObjectInfo 参数 是否必选 参数类型 描述 object_id 是 String 黑名单中的对象id。 object_type 是 String 对象类型。 USER： 用户 USERGROUP： 用户组 object_name 否 String 对象名。后续此参数不会校验。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 操作的桌面ID列表。 op_type 是 String 操作类型。 -os-start 启动。 -reboot 重启。 -os-stop 关机。 -os-hibernate 休眠。 type 否 String SOFT：普通操作；HARD：强制操作。例如type为HARD，op_type为os-stop代表强制关机。 host_id 否 String 专属主机id，op_type值为os-start时本参数才生效，仅支持单个桌面操作，实现将关机的桌面先迁移到指定专属主机再开机，迁移过程耗时较长，需要等待一段时间。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 failed_operation_list Array of VmOperateResult objects 操作失败桌面列表。 job_id String 任务ID，冷迁移启动时返回。 表5 VmOperateResult 参数 参数类型 描述 desktop_id String 桌面ID。 desktop_name String 桌面名称。 error_code String 操作失败的错误码。 error_msg String 操作失败的原因描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 2, "items" : [ { "id" : "5af4a8c1047411ee9f75fa163e289e5a", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "user_name" : "user001@wksapp***.huawei.com", "app_group_name" : " 云存储 ", "app_group_id" : "573743978327834675", "app_name" : "云存储-Notepad++", "brokering_time" : "2023-06-06T14:13:48Z", "failed_code" : "", "connection_failure_reason" : "", "client_mac" : "00-e0-72-58-08-33", "client_name" : "DESKTOP-KDB5TN1", "client_ip" : "10.*73.109.160", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0529", "vm_ip" : "10.*.248.130", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "b5442cb1047211ee9f75fa163e289e5a", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "user_name" : "user001@wksapp***.huawei.com", "app_group_name" : "云存储", "app_group_id" : "573743978327834675", "app_name" : "云存储-Notepad++", "brokering_time" : "2023-06-06T14:02:00Z", "failed_code" : "", "connection_failure_reason" : "", "client_mac" : "00-e0-72-58-08-33", "client_name" : "DESKTOP-KDB5TN1", "client_ip" : "10.*73.109.160", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0529", "vm_ip" : "10.*.248.130", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of AppConnectionInfo objects 应用使用记录列表。 表6 AppConnectionInfo 参数 参数类型 描述 id String 应用连接唯一标识ID。 sid String 应用服务器sid。 machine_name String 应用服务器名称。 user_name String 登录用户。 app_group_name String 应用组名称。 app_group_id String 应用组ID。 app_name String 应用名称。 brokering_time String 登录应用时间。 failed_code String 连接失败状态码。 connection_failure_reason String 连接失败原因。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 wi_ip String 连接IP。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 主键。 sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 user_name 否 String 登录用户，模糊查询。 app_group_name 否 String 应用组名称。 app_group_id 否 String 应用组id。 app_name 否 String 应用名称，模糊查询。 failed_code 否 String 连接失败状态码。 connection_failure_reason 否 String 连接失败原因。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 wi_ip 否 String 连接IP。 tenant_id 否 String 租户id。 brokering_start_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 brokering_end_time 否 String 登录应用结束时间，格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。

响应示例 状态码： 200 查询OpenStack环境中的镜像响应。 { "total_count" : 1, "images" : [ { "id" : "d6b368bc-a24d-4fb5-a8fb-727356a53f33", "image_type" : "gold", "os_type" : "Linux", "os_version" : "EulerOS 2.2 64bit", "disk_format" : "qcow2", "name" : "Euler_Online_Tenant_vAG", "min_ram" : 0, "min_disk" : 50 }, { "id" : "bef99a44-2b6a-4ef9-b1a2-204a4910e374", "image_type" : "gold", "os_type" : "Linux", "os_version" : "EulerOS 2.5 64bit", "disk_format" : "qcow2", "name" : "FA-LZ-x86vAG-801temp", "min_ram" : 0, "min_disk" : 60 } ] }

URI GET /v2/{project_id}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 os_type 否 String 产品镜像的操作系统类型，如Windows。 image_type 否 String 镜像类型。 -gold 公共镜像 -private 私有镜像 platform 否 String 镜像系统类型,如Windows。 architecture 否 String 镜像架构：x86。 package_type 否 String 套餐系列 image_id 否 String 镜像Id limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量,默认0。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 images Array of ImageInfo objects 云桌面支持的产品镜像列表。 total_count Integer 对象总数。 表5 ImageInfo 参数 参数类型 描述 id String 镜像ID。 image_type String 镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private。 os_type String 操作系统类型，目前取值Linux， Windows，Other。 architecture String 操作系统架构，目前取值arm，x86 os_version String 操作系统具体版本。 disk_format String 镜像格式，目前支持vhd，raw，qcow2，zvhd2格式。 name String 镜像名称。 min_ram Integer 镜像运行需要的最小内存，单位为MB。参数取值依据弹性云服务器的规格限制，一般设置为0。 min_disk Integer 镜像运行需要的最小磁盘，单位为GB 。取值为40～1024GB。 product_code String 镜像的产品编码。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

API概览 表1 云桌面接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 桌面 查询、创建、修改、删除桌面等接口。 桌面统计 查询在指定时间段未使用的桌面、查询使用桌面的时长等接口。 桌面名称策略 查询、创建、删除用户等接口。 用户 查询、创建、删除用户组等接口。 用户组 增加、扩容磁盘接口。 磁盘 查询登录信息、导出连接记录等接口。 连接信息 查询、创建、删除接入策略等接口。 策略组 查询产品套餐列表接口。 产品套餐 查询、更新辅助认证配置接口。 认证配置 查询租户配额接口。 配额 查询产品镜像列表接口。 镜像 查询可用分区列表接口。 可用分区 子任务查询。 桌面标签 查询已绑定桌面和未绑定的EIP、桌面绑定EIP、开通桌面上网功能等接口。 任务 查询、设置终端与桌面绑定开关及配置等接口。 网络 查询、查询、增加终端与桌面绑定等接口 表2 云应用接口说明 类型 说明 产品套餐管理 查询云应用套餐及会话套餐列表接口。 可用区管理 查询可用分区列表接口。 磁盘管理 查询磁盘接口。 服务器组管理 查询、创建、删除、修改服务器组列表等接口。 服务器管理 查询、创建、删除、修改、启动、重启服务器等接口。 应用组管理 查询、创建、删除、修改应用组等接口。 应用管理 查询发布应用、修改应用信息等接口。 应用授权管理 查询应用组授权、移除授权等接口。 使用记录 查询应用使用记录、用户会话注销等接口。 策略管理 查询、创建、删除、修改策略等接口。 存储管理 查询、创建、删除WKS存储等接口。 查询Job状态 查询任务的执行状态接口。 配额管理 查询配额校验接口。

前提条件 管理员已成功购买桌面。 管理员已具有弹性文件服务的操作权限。 自主注册的华为云帐号默认拥有华为云所有服务的操作权限，如果您使用的是此类帐号，无需再进行确认。 华为云帐号下新建的IAM帐号，需要加入“admin”内置用户组，或者拥有弹性文件服务操作权限的用户组，才可使用弹性文件服务。可进入“ 统一身份认证 服务”中查看是否属于“admin”内置用户组。如果非“admin”内置用户组，请参见弹性文件服务授权赋予IAM帐号使用弹性文件服务的权限。

前提条件 已购买云桌面。 管理员帐号已具备云备份服务操作权限。 自主注册的华为云帐号默认拥有华为云所有服务的操作权限，如果您使用的是此类帐号，无需再进行确认。 华为云帐号下新建的IAM帐号，需要加入“admin”内置用户组，或者拥有云备份服务操作权限的用户组，才可使用云备份服务。可进入“统一身份认证服务”中查看是否属于“admin”内置用户组。如果非“admin”内置用户组，请参见云备份服务授权赋予IAM帐号使用云备份服务的权限。

VPN自定义策略样例 示例1：授权用户删除VPN网关 { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "vpn:vpnGateways:delete" ] } ] } 示例2：拒绝用户删除VPN连接 拒绝策略需要同时配合其他策略使用，否则没有实际作用。用户被授予的策略中，一个授权项的作用如果同时存在Allow和Deny，则遵循Deny优先原则。 如果您给用户授予VPN FullAccess的系统策略，但不希望用户拥有VPN FullAccess中定义的删除VPN连接权限，您可以创建一条拒绝删除VPN连接的自定义策略，然后同时将VPN FullAccess和拒绝策略授予用户，根据Deny优先原则，则用户可以对VPN执行除了删除VPN连接外的所有操作。拒绝策略示例如下： { "Version": "1.1", "Statement": [ { "Effect": "Deny", "Action": [ "vpn:vpnGateways:delete" ] } ] } 示例3：多个授权项策略 一个自定义策略中可以包含多个授权项，且除了可以包含本服务的授权项外，还可以包含其他服务的授权项，可以包含的其他服务必须跟本服务同属性，即都是项目级服务或都是全局级服务。多个授权语句策略描述如下： { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "vpn:vpnGateways:create", "vpn:vpnConnections:create", "vpn:customerGateways:create" ] }, { "Effect": "Deny", "Action": [ "vpn:vpnGateways:delete", "vpn:vpnConnections:delete", "vpn:customerGateways:create" ] }, { "Effect": "Allow", "Action": [ "vpc:vpcs:list", "vpc:subnets:get" ] } ] }

变更计费模式概述 在购买VPN后，如果发现当前计费模式无法满足业务需求，您可以变更计费模式。支持变更计费模式的VPN计费项如表1所示。 表1 支持变更计费模式的VPN计费项 计费项 变更说明 相关文档 VPN网关 将VPN网关实例的计费模式从按需计费转为包年/包月，可以让您享受一定程度的价格优惠。 将包年/包月企业版VPN网关升级为支持非固定IP接入的规格。 按需、按带宽计费经典版VPN网关支持和按需、按流量计费VPN网关相互转换。 按需、按带宽计费经典版VPN网关支持带宽升降配。 企业版VPN： 按需VPN网关转包年/包月 包年/包月VPN网关变更规格 经典版VPN 按需按带宽转包年/包月 按需按流量转包年/包月 按需按带宽与按需按流量相互转换 按需按带宽进行带宽升降配 VPN连接组 包年/包月企业版VPN（非基础型）支持VPN连接组数升降配。 包年/包月VPN连接组数升降配 EIP 包年/包月EIP支持到期后转为按需、按带宽计费EIP。 按需、按带宽计费EIP支持转为包年/包月EIP。 按需、按带宽计费EIP支持和按需、按流量计费EIP互转。 具体变更方式可参考图1。 请参见弹性公网IP变更计费模式概述。 图1 EIP计费模式变更 父主题： 变更计费模式