华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 control_mode 否 String 控制模式 BLACK：黑名单控制。 WHITE：白名单控制。 add_control_list 否 Array of strings 待添加的桌面。 remove_control_list 否 Array of strings 待删除的桌面。

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/actions/batch-delete-authorization { "app_group_ids" : [ "571784876773081141" ], "accounts" : [ { "account" : "user000", "account_type" : "USER", "domain" : "wksapp***.huawei.com" } ] }

响应参数 状态码：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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 X-Language 否 String 语言： zh-cn：中文 en-us：英文 fr-fr: 法文 表3 请求Body参数 参数 是否必选 参数类型 描述 app_group_ids 是 Array of strings 应用组ID,最多同时操作10个。 accounts 是 Array of AccountInfo objects 用户(组),单次最多允许操作50个用户(组)。 表4 AccountInfo 参数 是否必选 参数类型 描述 id 否 String 用户ID(或用户组ID)，根据 account_type 参数决定值类型。 对于用户组类型，必须传入用户组ID。 USER - 用户ID。 USER_GROUP - 用户组ID。 account 是 String 用户名(或用户组名)，根据 account_type 参数决定值类型。 USER - 用户名。 USER_GROUP - 用户组名。 account_type 是 String 用户类型： USER - 用户 USER_GROUP - 用户组 domain 否 String 域名 城。 email 否 String 邮箱。 telephone_number 否 String 手机。 platform_type 否 String 平台类型： AD - AD域 LOCAL - LiteAs SYSTEM - 系统内置

响应示例 状态码：200 响应成功。 { "count" : 0, "items" : [ { "rule_id" : "xxxx-xxxx-xxxx", "metric_name" : "desktop_idle_duration", "threshold" : 30, "comparison_operator" : "", "interval" : 1, "enable" : true, "notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName" } ] }

URI GET /v2/{project_id}/statistics/notify-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 metric_name 否 String 指标名称(精确匹配)。 rule_id 否 String 通知规则ID。 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 单次查询的大小[1-100],默认值10。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 volumes 否 Array of VolumeAddInfo objects 增加的磁盘列表。 表4 VolumeAddInfo 参数 是否必选 参数类型 描述 id 否 String 磁盘记录ID，删除或者扩容磁盘时必选。 type 是 String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。 size 是 Integer 磁盘容量，单位GB。

响应参数 状态码：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 包周期桌面池批量询价响应体。 { "currency" : "string", "cloud_service_rating_results" : [ { "order_request_id" : "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" } ] } ] } ] }

请求参数 表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。 image_spec_code 否 String 云市场镜像的specCode，即将停用。image_spec_code与image_id同时存在时取image_id的值，两者不可同时为空。 image_id 否 String 云市场镜像ID，建议使用image_id。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 currency String 币种，比如CNY。 cloud_service_rating_results Array of CloudServiceRatingResult objects 询价结果。 表5 CloudServiceRatingResult 参数 参数类型 描述 order_request_id String 下单请求体中的orderRequestId。 official_website_rating_result OfficialWebsiteRatingResult object 结果。 optional_discount_rating_results Array of OptionalDiscountRatingResult objects 优惠询价结果。 表6 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 产品询价结果。 表7 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 产品询价结果。 表8 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 表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 表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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 volumes 否 Array of VolumeInfo objects 删除的桌面池磁盘列表。 表4 VolumeInfo 参数 是否必选 参数类型 描述 id 否 String 批量操作磁盘的磁盘集合id。 type 是 String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。 size 是 Integer 磁盘容量，单位GB。 resource_spec_code 否 String 规格。

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/workspaces { "access_mode" : "BOTH" } { "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_ip" : "192.161.43.66", "standby_domain_ip" : "192.161.43.67", "domain_name" : "vdesktop.huawei.com", "domain_password" : "xxxxxxxxxx@", "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com", "active_dns_ip" : "192.161.43.66", "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com", "standby_dns_ip" : "192.161.43.67", "use_ldaps" : true, "tls_config" : { "cert_pem" : "-----BEGIN CERTIFICATE-----\\nMIIDiTCCAnGgAwIBAgIQQdj2u+x1LJ9Dc34un\\n-----END CERTIFICATE" } } } { "access_mode" : "DEDICATED", "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16" } { "is_send_email" : false }

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 job_id String 修改云办公服务属性的任务ID。 enterprise_id String 企业ID。 dc_vnc_ip String 专线vnc访问的ip。 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表14 响应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参数 参数 是否必选 参数类型 描述 ad_info 否 AdDomainInfo object 域信息。 ad_domains 否 AdDomain object 域信息。 access_mode 否 String 接入模式。 INTERNET：互联网接入。 DEDICATED：专线接入。 BOTH：代表两种接入方式都支持。 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 adn_conflict_network 否 String ADN上网冲突网段列表，多个网段信息用分号隔开，列表长度不超过50。 subnet_ids 否 Array of strings 子网的网络ID列表。 internet_access_port 否 String 互联网接入端口。 enterprise_id 否 String 企业ID。 is_send_email 否 Boolean 桌面退订是否发送邮件通知。 dc_vnc_ip 否 String 开通专线访问VNC功能，如果传入的是default则自动创建，如果传入的自定义的dc_vnc_ip则直接使用，如果传入的是close表示关闭自定义VNC。 authorized_collect_log 否 Boolean 是否授权收集日志。 authorized_hda_upgrade 否 Boolean 是否授权hda升级。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参。 apply_dedicated_standby_network_param 否 ApplyDedicatedStandbyNetworkParam object 开通专线备用线路入参。 is_authorized_install_agent 否 Boolean 是否授权桌面自动安装agent插件。 enable_user_create_snapshot 否 Boolean 是否授权最终租户创建快照。 表4 AdDomainInfo 参数 是否必选 参数类型 描述 domain_type 是 String 域类型。 LITE_AS：LiteAS。 LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与“LOCAL_AD”所属网络可连通。 domain_admin_account 是 String 域管理员帐号。 domain_password 是 String 域管理员账号密码。 表5 AdDomain 参数 是否必选 参数类型 描述 domain_type 是 String 域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与AD所属网络可连通。 domain_name 否 String 域名称。域类型为LOCAL_AD时需要配置。 域名必须为AD服务器上已经存在的域名，且长度不超过55。 domain_admin_account 否 String 域管理员帐号。域类型为LOCAL_AD时需要配置。 必须为AD服务器上已经存在的域管理员帐号。 domain_password 否 String 域管理员账号密码。域类型为LOCAL_AD时需要配置。 active_domain_ip 否 String 主域控制器IP地址。域类型为LOCAL_AD时需要配置。 active_domain_name 否 String 主域控制器名称。域类型为LOCAL_AD时需要配置。 standby_domain_ip 否 String 备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 standby_domain_name 否 String 备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。 active_dns_ip 否 String 主DNS IP地址。域类型为LOCAL_AD时需要配置。 standby_dns_ip 否 String 备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 delete_computer_object 否 Integer 是否在删除桌面的同时删除AD上对应的计算机对象，0代表不删除，1代表删除。 use_ldaps 否 Boolean 是否开启LDAPS。 tls_config 否 TlsConfig object TLS信息。 表6 TlsConfig 参数 是否必选 参数类型 描述 cert_pem 否 String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time 否 String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time 否 String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表7 ApplySharedVpcDedicatedParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的共享Vpc专线地址。 port 否 Integer 租户指定共享Vpc专线地址端口。 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区。 表8 ApplyDedicatedStandbyNetworkParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的专线备用地址。 port 否 Integer 租户指定的专线备用地址端口。 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区。

响应参数 状态码：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接口进行解密。

URI GET /v2/{project_id}/connections/desktops/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 查询的起始时间。指定该参数后，返回的结果为此时间之后的所有登录记录。时间格式如：“2016-08-20T21:11Z”。终止时间不为空时，起始时间为必填参数。 end_time 否 String 查询的终止时间。指定该参数后，返回的结果为此时间之前的所有登录记录。时间格式如：“2016-08-20T21:11Z”。起始时间不为空时，终止时间为必填参数。 user_name 否 String 登录桌面的用户名。 computer_name 否 String 计算机名（操作系统信息中可见）。 terminal_type 否 String 登录桌面的终端系统类型。 language 否 String 导出语言，默认英文。 zh_CN：中文 en_US：英文

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

请求示例 { "gray_count" : 1, "resource_type" : "desktop", "resource_ids" : [ { "resource_id" : "0000000059071dbc01591661d3990019" } ], "script_ids" : [ { "script_id" : "0000000059071dbc01591661d3990019" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_id String 执行脚本的任务ID。 状态码：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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 gray_count 否 Integer 灰度资源数量。 resource_type 否 String 资源类型，如桌面(DESKTOP)。 gray_resource_ids 否 Array of strings 灰度执行脚本的资源列表。 gray_fail_threshold 否 Integer 灰度失败阈值，达到阈值后停止进行下一批资源执行脚本，小于gray_count。 resource_ids 否 Array of strings 执行脚本的资源列表。 execution_timeout 否 Integer 执行脚本的超时时间，单位分钟。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码：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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_ids 是 Array of strings 应用服务器id集合。 host_id 是 String 目标云办公主机id。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 control_mode String 控制模式 BLACK：黑名单控制。 WHITE：白名单控制。 control_list Array of ControlItem objects 控制的桌面列表。 total_count Integer 总数。 表5 ControlItem 参数 参数类型 描述 desktop_id String 桌面id。 desktop_name String 桌面名称。 desktop_status String 桌面状态。 pool_id String 池id。 attach_user_infos Array of AttachInstancesUserInfo objects 桌面已分配的用户信息列表。 表6 AttachInstancesUserInfo 参数 参数类型 描述 user_id String 当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在； user_name String 桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-64]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。 user_group String 桌面用户所属的用户组。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 type String 对象类型，可选值为： USER：用户。 GROUP：用户组。 状态码：default 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询云办公带宽的控制配置响应。 { "control_mode" : "string", "control_list" : [ { "desktop_id" : "string", "desktop_name" : "string", "desktop_status" : "string", "pool_id" : "string", "attach_user_infos" : [ { "user_id" : "string", "user_name" : "string", "user_group" : "string", "type" : "USER" } ] } ], "total_count" : 0 }

URI GET /v2/{project_id}/bandwidths/{bandwidth_id}/control-list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 bandwidth_id 是 String 云办公带宽id。 表2 Query参数 参数 是否必选 参数类型 描述 desktop_id 否 String 桌面id。 desktop_name 否 String 桌面名称。 user_name 否 String 桌面分配用户。 control_mode 否 String 控制模式，支持： BLACK 黑名单 WHITE 白名单 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回桌面数量限制。如果不指定，则返回所有符合条件的记录。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码：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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量唯一标识请求列表，一次请求数量区间 [1, 20]。 recursive 是 Boolean 是否同时删除镜像实例关联资源： ⚠ 警告: 关联资源删除，对应的应用将不可用 true 同时删除关联资源，包括APS服务器组，APS服务器，应用组相关资源。镜像产物相关信息保留。 false 只删除镜像实例记录，保留关联资源。

请求示例 /v2/0e69423d4400f4a82f67c0059a1e4cc8/internet { "nat_spec" : "string", "eip_charge_mode" : "string", "bandwidth_size" : 1, "eip_type" : "string", "vpc_id" : "string", "subnet_id" : "string", "enterprise_project_id" : "string", "nat_name" : "string", "eip_name" : "string" }