华为云用户手册

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 in_use_num Integer 使用中。 unregistered_num Integer 未注册数目。 unable_to_connect_num Integer 未注册数目。 ready_num Integer 空闲数目。 disconnected_num Integer 断开连接数目。 状态码：default 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 正常。 { "desktop" : { "desktop_id" : "string", "computer_name" : "string", "os_host_name" : "string", "addresses" : { "additionalProp1" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ], "additionalProp2" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ], "additionalProp3" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ] }, "ip_addresses" : [ "string" ], "ipv4" : "string", "ipv6" : "string", "user_list" : [ "string" ], "user_group_list" : [ "string" ], "desktop_type" : "string", "resource_type" : "string", "metadata" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "flavor" : { "id" : "string", "links" : [ { "rel" : "string", "hrel" : "string" } ] }, "status" : "string", "task_status" : "string", "in_maintenance_mode" : true, "created" : "string", "security_groups" : [ { "id" : "string", "name" : "string" } ], "login_status" : "string", "user_name" : "string", "attach_user_infos" : [ { "user_id" : "string", "user_name" : "string", "user_group" : "string", "type" : "USER" } ], "product_id" : "string", "share_resource_sku" : "string", "root_volume" : { "encrypt_flag" : "strin", "kms_key" : "string", "key_alias" : "string", "type" : "string", "size" : 2147483647, "kms_grant_id" : "string", "device" : "string", "id" : "string", "volume_id" : "string", "bill_resource_id" : "string", "create_time" : "string", "display_name" : "string", "cluster_id" : "string", "resource_spec_code" : "string" }, "data_volumes" : [ { "encrypt_flag" : "strin", "kms_key" : "string", "key_alias" : "string", "type" : "string", "size" : 2147483647, "kms_grant_id" : "string", "device" : "string", "id" : "string", "volume_id" : "string", "bill_resource_id" : "string", "create_time" : "string", "display_name" : "string", "cluster_id" : "string", "resource_spec_code" : "string" } ], "user_group" : "string", "availability_zone" : "string", "site_type" : "string", "site_name" : "string", "product" : { "product_id" : "string", "flavor_id" : "string", "type" : "string", "cpu" : "string", "memory" : "string", "descriptions" : "string。", "charge_mode" : "s", "architecture" : "string", "cpu_desc" : "string", "is_gpu" : true, "package_type" : "string", "system_disk_type" : "SAS", "system_disk_size" : "80", "gpu_desc" : "string", "contain_data_disk" : true, "resource_type" : "string", "cloud_service_type" : "string", "volume_product_type" : "string", "status" : "string", "sub_product_list" : [ "string" ] }, "ou_name" : "string", "os_version" : "string", "sid" : "string", "join_domain" : "s", "order_id" : "string", "tags" : [ { "key" : "string", "value" : "" } ], "deh_id" : "string", "platform_kind" : 100, "is_support_internet" : true, "internet_mode" : "string", "internet_mode_list" : [ "string" ], "need_apply_adn" : true, "is_attaching_eip" : true, "desktop_isv" : "DEFAULT", "creation_type" : "string", "attach_state" : "string", "enterprise_project_id" : "string", "subnet_id" : "string", "bill_resource_id" : "string", "process" : 0, "root_resource_id" : "string", "hour_package_info" : { "root_order_id" : "string", "package_resource_id" : "string", "package_instance_id" : "string", "package_spec_code" : "string", "combined_product_type_code" : "string", "use_up_policy" : "string", "package_duration" : 0, "use_duration" : 0 } } }

请求示例 PUT /v2/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups/401a23865cae63f3015cceb9affe0049/targets { "add" : [ { "target_id" : "xxxx-xxxx-xxxx-xxxx", "target_type" : "USER", "target_name" : "All-Targets-123" } ], "delete" : [ { "target_id" : "xxxx-xxxx-xxxx-xxxx", "target_type" : "USER", "target_name" : "All-Targets-456" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 add 否 Array of Target objects 添加应用。 delete 否 Array of Target objects 删除应用。 表4 Target 参数 是否必选 参数类型 描述 target_id 否 String 对象ID。 target_name 否 String 对象名称。 target_type 否 String 对象类型。 INSTANCE：表示桌面。 target_id：为桌面的SID。 target_name：为桌面name。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 CLIENTIP：终端IP地址。 target_id：终端IP地址。 target_name：终端IP地址。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 DESKTOPSPOOL：表示桌面池。 target_id：为桌面池的ID。 target_name：为桌面池name。 ALL：表示所有桌面。 target_id：default-apply-all-targets。 target_name：All-Targets。

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 bind_result_list Array of CreateTerminalsBindingDesktopsResult objects 绑定策略创建结果。 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 表6 CreateTerminalsBindingDesktopsResult 参数 参数类型 描述 line Integer 行号，用于批量导入。 mac String 终端MAC地址。 sid String 虚拟机ID。 desktop_name String 桌面名称，用于批量导入。 validation_result_code String 绑定策略校验结果码。 validation_result_msg String 绑定策略校验结果信息，用于标识批量导入中绑定策略的校验结果。 description String 描述。 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例 post /v2/fb2e5ec048384c8f9469d22db0037908/terminals/binding-desktops { "bind_list" : [ { "line" : 0, "mac" : "AA-BB-CC-DD-EE-FF", "desktop_name" : "test01", "description" : "test。" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 bind_list 否 Array of CreateTerminalsBindingDesktopsInfo objects 需要新增的MAC绑定VM策略信息列表。 表4 CreateTerminalsBindingDesktopsInfo 参数 是否必选 参数类型 描述 line 否 Integer 行号,用于批量导入。 mac 否 String 终端mac地址。 desktop_name 否 String 桌面名称，用于批量导入。 description 否 String 描述。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 cpu_info Array of DataPoints objects cpu使用率信息。 memory_info Array of DataPoints objects 内存使用率信息。 disk_util_inband Array of DataPoints objects 磁盘使用率。 disk_read_bytes_rate Array of DataPoints objects 磁盘读带宽。 disk_write_bytes_rate Array of DataPoints objects 磁盘写带宽。 disk_read_requests_rate Array of DataPoints objects 磁盘读IOPS。 disk_write_requests_rate Array of DataPoints objects 磁盘写IOPS。 network_incoming_bytes_rate_inband Array of DataPoints objects 带内网络流入速率。 network_outgoing_bytes_rate_inband Array of DataPoints objects 带内网络流出速率。 network_incoming_bytes_aggregate_rate Array of DataPoints objects 带外网络流入速率。 network_outgoing_bytes_aggregate_rate Array of DataPoints objects 带外网络流出速率。 network_vm_connections Array of DataPoints objects 网络连接数。 表5 DataPoints 参数 参数类型 描述 average Double 平均数值。 timestamp Long 时间戳。 状态码：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 操作成功。 { "cpu_info" : [ { "average" : 0.4832775919732441, "timestamp" : 1618810632000 }, { "average" : 0.4832775919732441, "timestamp" : 1618810931000 }, { "average" : 0.5018382352941176, "timestamp" : 1618811203000 }, { "average" : 0.4830508474576271, "timestamp" : 1618812396000 } ], "disk_read_bytes_rate" : [ { "average" : 0.4832775919732441, "timestamp" : 1618810632000 } ], "memory_info" : [ { "average" : 12.501838235294118, "timestamp" : 1618811203000 }, { "average" : 12.483050847457626, "timestamp" : 1618812396000 } ], "disk_util_inband" : [ { "average" : 12.483050847457626, "timestamp" : 1618812396000 } ], "disk_write_bytes_rate" : [ { "average" : 12.483050847457626, "timestamp" : 1618812396000 } ], "disk_read_requests_rate" : [ { "average" : 12.48, "timestamp" : 1618812396000 } ], "network_outgoing_bytes_rate_inband" : [ { "average" : 170.5190311418685, "timestamp" : 1618812396000 } ], "network_incoming_bytes_aggregate_rate" : [ { "average" : 158.4299674267101, "timestamp" : 1618812396000 } ], "network_outgoing_bytes_aggregate_rate" : [ { "average" : 144.38275862068966, "timestamp" : 1618812396000 } ] }

URI GET /v1/{project_id}/app-servers/metric-data/{server_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 server_id 是 String 服务器唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 监控开始时间：由日期加时间组成，UTC格式，例如“2021-05-11T11:45:42.000Z”。 end_time 是 String 监控结束时间：由日期加时间组成，UTC格式，例如“2021-05-11T11:45:42.000Z”。 metric_name 否 String 监控查询指标：例如 "cpu_util"，详情见下表；当metric_name为空时，为批量查询。| 指标 | 指标名称 | 测量对象 | 监控周期 || ------------------------------------- | ----------------- | ------------ | -------- || cpu_util | CPU使用率 | 弹性云服务器 | 5分钟 || mem_util | 内存使用率 | 弹性云服务器 | 5分钟 || disk_util_inband | 磁盘使用率 | 弹性云服务器 | 5分钟 || disk_read_bytes_rate | 磁盘读带宽 | 弹性云服务器 | 5分钟 || disk_write_bytes_rate | 磁盘写带宽 | 弹性云服务器 | 5分钟 || disk_read_requests_rate | 磁盘读IOPS | 弹性云服务器 | 5分钟 || disk_write_requests_rate | 磁盘写IOPS | 弹性云服务器 | 5分钟 || network_incoming_bytes_rate_inband | 带内网络流入速率 | 弹性云服务器 | 5分钟 || network_outgoing_bytes_rate_inband | 带内网络流出速率 | 弹性云服务器 | 5分钟 || network_incoming_bytes_aggregate_rate | 带外网络流入速率 | 弹性云服务器 | 5分钟 || network_outgoing_bytes_aggregate_rate | 带外网络流出速率 | 弹性云服务器 | 5分钟 |

请求示例 /v2/{project_id}/desktops/resource_instances/action { "offset" : "0", "limit" : "1000", "action" : "string", "without_any_tag" : true, "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "tags" : [ { "key" : "string", "values" : [ "string" ] } ], "tags_any" : [ { "key" : "string", "values" : [ "string" ] } ], "not_tags" : [ { "key" : "string", "values" : [ "string" ] } ], "not_tags_any" : [ { "key" : "string", "values" : [ "string" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 String 默认为0。 limit 否 String 默认为1000。 action 否 String 如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可。 without_any_tag 否 Boolean 包含任意一个标签,该字段为true时查询所有不带标签的资源。 matches 否 Array of Match objects match对象。 tags 否 Array of Tags objects 包含的标签对象，只要有一个不包含，就不符合，一个key对应多个value。 tags_any 否 Array of Tags objects 包含任意标签，若全都不包含，不符合，一个key对应多个value。 not_tags 否 Array of Tags objects 不包含标签，只要有一个不包含，就符合了，一个key对应多个value。 not_tags_any 否 Array of Tags objects 不包含任意标签，只要包含其中一个，就不符合，一个key对应多个value。 表4 Match 参数 是否必选 参数类型 描述 key 是 String 搜索时要匹配的字段。 value 是 String 搜索时匹配的值，当key=resource_name时为模糊匹配。 表5 Tags 参数 是否必选 参数类型 描述 key 否 String 标签key。 values 否 Array of strings 标签value。

响应示例 状态码：200 正常。 { "offset" : 0, "resources" : [ { "resource_detail" : "string", "resource_id" : "string", "resource_name" : "string", "tags" : [ { "key" : "string", "value" : "" } ] } ], "total_count" : 1000 }

响应示例 状态码：200 包周期桌面池批量询价响应体。 { "currency" : "string", "extend_params" : "string", "official_website_rating_result" : { "amount" : 0, "official_website_amount" : 0, "original_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "product_rating_results" : [ { "id" : "string", "product_id" : "string", "amount" : 0, "discount_amount" : 0, "original_amount" : 0, "official_website_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "extend_params" : "string" } ] }, "optional_discount_rating_results" : [ { "discount_id" : "string", "amount" : 0, "official_website_amount" : 0, "original_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "discount_type" : 0, "discount_name" : "string", "best_offer" : 0, "same_ratio_flag" : 0, "discount_ratio" : 0, "promotion_info" : "string", "product_rating_results" : [ { "id" : "string", "product_id" : "string", "amount" : 0, "discount_amount" : 0, "original_amount" : 0, "official_website_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "extend_params" : "string" } ] } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 currency String 币种，比如CNY。 extend_params String 扩展参数。 official_website_rating_result OfficialWebsiteRatingResult object 结果。 optional_discount_rating_results Array of OptionalDiscountRatingResult objects 存在可选折扣优惠时返回折扣优惠维度询价结果，每个折扣优惠一组询价结果。 表5 OfficialWebsiteRatingResult 参数 参数类型 描述 amount Number 订单总额，即最终优惠后的订单金额(预留实例只包含预付部分)。 official_website_amount Number 官网价(预留实例只包含预付部分)。 original_amount Number 订单原总额，即优惠前订单总额(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)。 discount_amount Number 总优惠额(预留实例只包含预付部分)。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 product_rating_results Array of ProductResult objects 产品询价结果。 表6 OptionalDiscountRatingResult 参数 参数类型 描述 discount_id String 折扣优惠Id。 amount Number 订单总额，即最终优惠后的订单金额(预留实例只包含预付部分)。 official_website_amount Number 官网价(预留实例只包含预付部分)。 original_amount Number 订单原总额，即优惠前订单总额(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)。 discount_amount Number 总优惠额(预留实例只包含预付部分)。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_official_website_amount Number 总分期金额的官网价(批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_official_website_discount_amount Number 总分期金额的官网价官网价优惠额，即： perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount (批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_optional_discount_amount Number 总分期金额的可选折扣优惠额，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount (批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 discount_type Integer 折扣优惠类型。 discount_name String 折扣名称。 best_offer Integer 是否为最优折扣0：不是最优折扣；为缺省值。1：是最优折扣；最优折扣：在商务折扣、伙伴折扣和促销折扣中选择（优惠金额相等则按此顺序排优先级），折扣券不参与最优折扣的计算。 same_ratio_flag Integer sameRatioFlag。 discount_ratio Number sameRatioFlag为1时有值，表示该折扣的折扣率。 promotion_info String 折扣优惠基本信息；调用者在确定好折扣优惠后、下单时，使用此字段值，填入到订购/变更接口中的promotionInfo字段。 product_rating_results Array of ProductResult objects 产品询价结果。 表7 ProductResult 参数 参数类型 描述 id String 对应请求体中的ID。 product_id String 产品ID。 amount Number 总额，即最终优惠后的金额(预留实例只包含预付部分)。 discount_amount Number 优惠额(预留实例只包含预付部分)。 original_amount Number 原总额，即优惠前总额(预留实例只包含预付部分)。 official_website_amount Number 官网价（非所有接口有该字段）(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额（非所有接口有该字段）(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额（非所有接口有该字段）。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_official_website_amount Number 分期金额的官网价。 per_official_website_discount_amount Number 分期金额的官网价官网价优惠额，即：perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount。 per_optional_discount_amount Number 分期金额的可选折扣优惠额，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 extend_params String 扩展参数。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 desktop_pool_disk_id 是 String 需要扩容的桌面池磁盘ID。 new_size 是 Integer 扩容后的磁盘大小。

响应示例 状态码：200 操作成功。 { "count" : 0, "records" : [ { "id" : "1", "account" : "zhangsan*", "account_auth_type" : "USER", "account_auth_name" : "zhangsan*", "app_group_id" : "1", "app_group_name" : "流程开发应用组", "mail_send_type" : "1", "mail_send_result" : "SUEE CES S", "error_msg" : "error:", "send_at" : "2022-03-07T10:40:43.858Z" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 records Array of AuthorizationMail objects 授权邮件信息。 表5 AuthorizationMail 参数 参数类型 描述 id String 邮件记录id。 account String 用户(组)。 account_auth_type String 用户类型： USER - 用户 USER_GROUP - 用户组 account_auth_name String 授权对象名称。 app_group_id String 应用组ID。 app_group_name String 应用组名称。 mail_send_type String 授权类型： - ADD_GROUP_AUTHORIZATION 添加组授权邮件 - DEL_GROUP_AUTHORIZATION 删除组授权邮件 - ADD_GROUP_AUTHORIZATION_ SMS 添加组授权短信 - DEL_GROUP_AUTHORIZATION_SMS 删除组授权短信。 mail_send_result String 发送结果。 - SUEECESS -发送成功 - FAIL -发送失败。 error_msg String 报错信息。 send_at 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 错误描述。 状态码：415 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/mails 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]，默认值10。 offset 否 Integer 查询的偏移量，默认值0。 app_group_id 是 String 应用组ID。 account 否 String 用户(组)名称。 mail_send_type 否 String 授权类型： - ADD_GROUP_AUTHORIZATION 添加组授权 - DEL_GROUP_AUTHORIZATION 删除组授权。 mail_send_result 否 String 邮件发送结果(SUCCESS|FAIL)。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 发送桌面消息任务id。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/products/sharer 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 产品ID。 share_space_size 否 String 协同方数。该套餐支持的最大协同人数。 charge_mode 否 String 周期套餐标识。0表示包周期，1表示按需, 6表示一次性计费。 is_gpu 否 Integer 是否是GPU套餐。1表示GPU套餐，0表示非GPU套餐，默认null查询所有类型。 package_type 否 String 套餐系列。user_sharer表示用户协同套餐，desktop_sharer表示桌面协同套餐。 limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量，默认0。

响应示例 状态码：200 查询协同套餐列表响应。 { "total_count" : 2, "products" : [ { "product_id" : "workspace.collaborativedesktop.6party.standard", "descriptions" : "协同资源|6方|标准版。", "resource_type" : "hws.resource.type.collaborativedesktop", "cloud_service_type" : "hws.service.type.vdi", "package_type" : "desktop_sharer", "share_space_size" : "6", "charge_mode" : "0", "is_gpu" : true }, { "product_id" : "workspace.collaborativedesktop.collabpartsubusers.1", "descriptions" : "协同参与方订阅|1用户。", "resource_type" : "hws.resource.type.collaborativedesktop", "cloud_service_type" : "hws.service.type.vdi", "package_type" : "user_sharer", "charge_mode" : "6" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 users Array of UserInGroup objects 组关联的用户列表。 total_count Integer 用户列表中用户总数。 表5 UserInGroup 参数 参数类型 描述 id String 用户ID。 user_name String 桌面用户名。 user_email String 用户邮箱。 user_phone String 用户手机号。 total_desktops Integer 用户桌面数。 description String 用户描述。

响应示例 状态码：200 组关联的用户列表响应。 { "total_count" : 2, "users" : [ { "user_name" : "user1", "user_email" : "xx1@mail.com", "user_phone" : "18818008887", "id" : "8357fd328c62447d94e452bf49xxxx" }, { "user_name" : "user2", "user_email" : "xx2@mail.com", "user_phone" : "18818008888", "id" : "8357fd328c62447d94e452bf495xxxx" } ] }

URI GET /v2/{project_id}/groups/{group_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 group_id 是 String 用户组ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名支持模糊查询。 description 否 String 用户描述支持模糊查询。 active_type 否 String 激活类型。 USER_ACTIVATE：用户激活 ADMIN_ACTIVATE：管理员激活 limit 否 String 用于分页查询，返回桌面数量限制。如果不指定或为0，默认2000，最大2000。 offset 否 String 用于分页查询，查询的起始记录序号，从0开始。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 桌面列表。 notifications 是 String 消息通知 内容。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 发送桌面消息任务id。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 otp_config_info OtpConfigInfo object OTP辅助认证方式配置。 表4 OtpConfigInfo 参数 参数类型 描述 enable Boolean 是否启用。 receive_mode String 验证码接收模式 VMFA：虚拟MFA设备 HMFA：硬件MFA设备 auth_url String 辅助认证服务器地址。 app_id String 认证服务接入账号。 app_secret String 认证服务接入密码。 auth_server_access_mode String 辅助认证服务接入模式 INTERNET：互联网接入 DEDICATED：专线接入 SYSTEM_DEFAULT：系统默认 cert_content String pem格式证书内容。 apply_rule ApplyRuleInfo object 认证应用对象信息，为null时代表对所有应用对象生效。 表5 ApplyRuleInfo 参数 参数类型 描述 rule_type String 认证应用对象类型。 ACCESS_MODE：接入类型 rule String 认证应用对象。 INTERNET：互联网接入，rule_type为ACCESS_MODE时可选该值 PRIVATE：专线接入，rule_type为ACCESS_MODE时可选该值 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。