华为云用户手册

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 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接口进行解密。 状态码：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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 用户描述。 user_email 否 String 用户邮箱。 user_phone 否 String 手机号。 active_type 否 String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 account_expires 否 String 账户过期时间，0表示永远不过期。 enable_change_password 否 Boolean 是否允许修改密码，true表示允许，false表示不允许。 next_login_change_password 否 Boolean 下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。 password_never_expired 否 Boolean 密码是否永不过期，true表示密码永不过期，false表示密码会过期。 disabled 否 Boolean 账户是否禁用，true表示被禁用，false表示未禁用。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 order_id String 订单号，下单成功时返回订单ID。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_name 否 String 云办公带宽名称。 bandwidth_size 是 String 变更云办公带宽的带宽大小。 enterprise_project_id 否 String 企业项目ID。 extend_param 否 OrderExtendParam object 订单的扩展参数。 表4 OrderExtendParam 参数 是否必选 参数类型 描述 is_auto_pay 否 String 是否自动付款。true:自动支付; false：不自动支付;默认false。

URI GET /v2/{project_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 用于分页查询，返回用户组数量限制。如果不指定或为0，则使用默认值100，从1开始，最大100。 offset 否 String 用于分页查询，查询的起始记录序号，从0开始，默认值0，必须与limit同时使用。 keyword 否 String 用来匹配用户组的搜索关键字。例如根据组名模糊查询。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 满足条件的用户组总数。 user_groups Array of UserGroupInfo objects 用户组列表。 表5 UserGroupInfo 参数 参数类型 描述 name String 用户组名。 id String 用户组ID。 create_time String 用户组对应的创建时间，UTC时间：yyyy-MM-ddTHH:mm:ss.SSSZ。 description String 用户组描述。 user_quantity Integer 用户列表中用户数。 parent UserGroupInfo object 用户组上级用户组。 realm_id String 用户组域Id。 platform_type String 用户组类型。 AD： AD域用户组 LOCAL： 本地liteAs用户组 group_dn String 用户组专有名。 domain String 用户组 域名 。 sid String 用户组sid。 total_desktops Integer 用户列表中用户数。 状态码：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接口进行解密。 状态码：405 表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接口进行解密。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

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

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

响应示例 状态码：200 预批量分配 云桌面 响应。 { "assign_dimension" : "USER", "desktop" : [ ], "user" : [ { "user_name" : "user1", "user_id" : "21bb9f13e6ff42fb96cd62489c446935", "desktop_num" : 1, "desktop_name" : "MARKETNOUSER17" }, { "user_name" : "user2", "user_id" : "3f6cc4c5d1ff4a79ab826b7964e9ff5d", "desktop_num" : 1, "desktop_name" : "MARKETNOUSER18" } ] }

请求示例 { "desktops" : [ { "desktop_id" : "b41a8cc1-4813-47a0-bf3a-7800fcd5b581" }, { "desktop_id" : "5f4ed564-14eb-44fd-8ff7-0483725a532b" }, { "desktop_id" : "dfdddcf4-f943-43b4-987b-e5785022d6c5" } ], "users" : [ { "user_id" : "3f6cc4c5d1ff4a79ab826b7964e9ff5d", "user_name" : "user1" }, { "user_id" : "21bb9f13e6ff42fb96cd62489c446935", "user_name" : "user2" } ], "assign_model" : { "assign_dimension" : "USER", "priority_strategy" : "USER_NO_DESKTOP", "desktop_assigin_user_num" : 2 } }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 assign_dimension String 分配的维度，当前支持“用户为维度”、“桌面为维度”两种。 desktop Array of DesktopDimensionAttachInfo objects 桌面维度结果，如果assign_dimension为DEKSTOP，那么取这个结果。 user Array of UserDimensionAttachInfo objects 用户维度结果，如果assign_dimension为USER，那么取这个结果。 desktops_attach_infos Array of AttachInstancesDesktopInfo objects 桌面分配关系。 表8 DesktopDimensionAttachInfo 参数 参数类型 描述 desktop_name String 桌面名称。 desktop_id String 桌面id。 user_num Integer 计划分配用户数。 user_name String 计划分配用户名称，如果有多个用逗号隔开。 表9 UserDimensionAttachInfo 参数 参数类型 描述 user_name String 用户名称。 user_id String 桌面id。 desktop_num Integer 计划分配桌面数。 desktop_name String 计划分配桌面名称，如果有多个用逗号隔开。 表10 AttachInstancesDesktopInfo 参数 参数类型 描述 desktop_id String 待分配的桌面ID。 user_name String 桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 user_email String 合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户。 user_group String 桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 computer_name String 桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为[1-15]。 is_clear_data Boolean 该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。 attach_user_infos Array of AttachInstancesUserInfo objects 待分配的用户信息列表,只有多用户桌面分配多人时有效。 表11 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：用户组。 状态码：400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表16 响应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参数 参数 是否必选 参数类型 描述 desktops 否 Array of AttachInstancesDesktopInfo objects 桌面信息列表。 users 否 Array of AttachInstancesUserInfo objects 用户信息列表。 assign_model 否 AssignModelInfo object 批量分配桌面策略。 表4 AttachInstancesDesktopInfo 参数 是否必选 参数类型 描述 desktop_id 否 String 待分配的桌面ID。 user_name 否 String 桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 user_email 否 String 合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户。 user_group 否 String 桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 computer_name 否 String 桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为[1-15]。 is_clear_data 否 Boolean 该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。 attach_user_infos 否 Array of AttachInstancesUserInfo objects 待分配的用户信息列表,只有多用户桌面分配多人时有效。 表5 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：用户组。 表6 AssignModelInfo 参数 是否必选 参数类型 描述 assign_dimension 否 String 分配的维度，当前支持 USER: “用户为维度” DESKTOP:“桌面为维度”两种。 priority_strategy 否 String 优先分配的策略，策略名为规则为{维度}_{子策略} USER_NO_DESKTOP: 用户维度-无桌面 USER_FIXED_DESKTOP_NUM: 用户维度-桌面个数固定 DESKTOP_ASSIGN_USER_PRIORITY： 桌面维度-用户优先 DESKTOP_ASSIGN_FIXED_USER： 桌面维度-固定用户 DESKTOP_ASSIGN_USERS_OR_GROUPS： 桌面维度-为每台桌面分配所选的所有用户（组） FIXED_RELATION: 使用参数中的固定分配关系 desktop_assigin_user_num 否 Integer 每个桌面自动分配的用户数，当子策略为 DESKTOP_ASSIGN_FIXED_USER 必填。 user_assigin_desktop_num 否 Integer 每个用户自动分配桌面数，当子策略为 USER_NO_DESKTOP、USER_FIXED_DESKTOP_NUM必填。 desktop_name_policy_id 否 String 策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。

响应参数 状态码：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 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码：200 正常。 { "desktop_actions" : [ { "action" : "stop", "start_time" : "2022-05-07T07:20:08.341609", "finish_time" : "2022-05-07T07:20:09.265125", "result" : "Success" } ], "total_count" : 1 }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 desktop_actions Array of DesktopAction objects 桌面开关列表。 total_count Integer 总数。 表5 DesktopAction 参数 参数类型 描述 action String 行为动作。 message String 行为完成状态信息。 start_time String 开始时间。 finish_time String 结束时间。 result String 结果。 traceback String 异常信息。 状态码：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}/desktops/{desktop_id}/actions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 desktop_id 是 String 桌面ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 每页限制数。 limit 否 Integer 起始位置。

请求示例 { "image_name" : "string", "image_description" : "string。", "desktop_id" : "string", "execute_sysprep" : "true", "image_tags" : [ { "key" : "string", "value" : "string" } ], "enterprise_project_id" : "string", "max_ram" : "string", "min_ram" : "string" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 image_name 是 String 镜像名称。 image_description 否 String 镜像描述信息。 desktop_id 是 String 用于制作镜像的云桌面的InstanceID。 execute_sysprep 否 Boolean 是否执行系统封装步骤。 image_tags 否 Array of TagKeyValue objects 镜像标签列表。 enterprise_project_id 否 String 表示当前镜像所属的企业项目。取值为0或无该值，表示属于default企业项目。取值为UUID，表示属于该UUID对应的企业项目。 max_ram 否 String 表示镜像支持的最大内存，单位为MB。 min_ram 否 String 表示镜像支持的最小内存，单位为MB，默认为0，表示不受限制。 表4 TagKeyValue 参数 是否必选 参数类型 描述 key 否 String 标签的键。 value 否 String 标签的值。

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

响应示例 状态码：200 成功响应。 { "count" : 2, "items" : [ { "id" : "394", "connect_type" : "2", "user_name" : "user001@wksapp***.huawei.com", "pre_conn_time" : "2023-06-05T03:34:43Z", "start_time" : "2023-06-05T06:37:47Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "failed_reason" : "", "failed_code" : "", "client_mac" : "c8-d9-d2-**-3a-57", "client_name" : "Y002516E2p1", "client_ip" : "10.*73.108.206", "client_version" : "23.2.2.0", "client_type" : "Windows 10", "agent_version" : "23.2.2.0423", "vm_ip" : "10.*.248.130", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-06-05T06:37:47Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "112", "connect_type" : "2", "user_name" : "nas01@wksapp***.huawei.com", "pre_conn_time" : "2023-05-23T09:10:03Z", "start_time" : "2023-05-23T09:10:04Z", "end_time" : "2023-05-23T09:16:15Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395", "machine_name" : "APS-Z5OV9E157G", "failed_reason" : "", "failed_code" : "", "client_mac" : "68-05-ca-**-c7-98", "client_name" : "kdjhfkjhdghschd", "client_ip" : "10.**.**.151", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0519", "vm_ip" : "10.*.83.5", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-05-23T09:16:15Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of UserConnectionInfo objects 应用使用记录列表。 表6 UserConnectionInfo 参数 参数类型 描述 id String 主键。 connect_type String 连接类型。 user_name String 登录用户。 desktop_group_name String 桌面组名。 pre_conn_time String 预连接时间。 start_time String 开始时间。 end_time String 结束时间。 machine_sid String 应用服务器sid。 machine_name String 应用服务器名称。 failed_reason String 连接失败原因。 failed_code 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。 connect_flag String 连接标志。 wi_ip String 连接IP。 update_time String 更新时间。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 public_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 登录记录唯一标识ID。 connect_type 否 String 用户连接类别。 user_name 否 String 登录用户名称。 machine_sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 failed_reason 否 String 连接失败原因。 failed_code 否 String 连接失败状态码。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 connect_flag 否 String 连接标志，目前值为0。 wi_ip 否 String 连接IP。 public_ip 否 String 客户端出口ip。 update_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 tenant_id 否 String 租户id。 login_start_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 login_end_time 否 String 登录应用结束时间，格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。

请求示例 { "name" : "notepad++.exe", "version" : "v1.1.1", "description" : "xxx。", "app_file_store" : { "store_type" : "OBS", "bucket_store" : { "bucket_name" : "wks-appcenter-xxxx", "bucket_file_path" : "app-file/xxxx.exe" }, "file_link" : "https://host-addresss/xxxxx.jpg" }, "app_icon_url" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8 /w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "install_type" : "QUIET_INSTALL", "authorization_type" : "ALL_USER", "install_command" : "${FILE_PATH} /S", "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet", "support_os" : "Windows", "catalog_id" : "xxxx-xxx-xxxx", "status" : "NORMAL", "install_info" : "xxxx-xxx-xxxx" }

响应示例 状态码：200 成功响应。 { "id" : "x-xx-xxx", "tenant_id" : "xxx-xx-x-xx", "name" : "xxx.exe", "version" : "v1.1.1", "description" : "测试应用。", "authorization_type" : "ALL_USER", "app_file_store" : { "store_type" : "OBS", "bucket_store" : { "bucket_name" : "wks-appcenter-xxxx", "bucket_file_path" : "app-file/xxxx.exe" }, "file_link" : "https://host-addresss/xxxxx.jpg" }, "app_icon_url" : "https://host-addresss/xxxxx", "install_type" : "QUIET_INSTALL", "install_command" : "${FILE_PATH} /S", "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet", "support_os" : "Windows", "status" : "NORMAL", "application_source" : "CUSTOM", "create_time" : "2024-12-25T06:58:19.765Z", "catalog_id" : 1, "catalog" : "其他", "install_info" : "安装信息" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用名称,名称需满足如下规则: 名称允许可见字符或空格，不可为全空格。 长度1~128个字符。 version 否 String 版本号。 description 否 String 描述。 app_file_store 否 FileStoreLink object 文件存储路径支持OBS或者外部链接，store_type指定实际生效的配置,bucket_store和file_link必须设置其一。 app_icon_url 否 String 图片的路径,支持使用可访问的URL地址或DataURIscheme。 可访问的URL - https://xxx.x.xx.x/xxx/xx.jpg。 DataURIscheme - data;image/png;base64,iVBORw0KGgoAAAANS; 注意使用dataURLStream时，最多支持约xxKB大小的图片，且必须是png格式。 install_type 否 String 安装方式： QUIET_INSTALL - 静默安装。 安装命令(静默安装命令)，例: ${FILE_PATH} /S。 UNZIP_INSTALL - 解压安装。 例: unzip ${FILE_PATH}。 GUI_INSTALL - 用户通过GUI界面安装。 install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 authorization_type 否 String ALL_USER - 全部用户 ASSIGN_USER - 授权指定用户 install_command 否 String 安装命令(静默安装命令)。 例: ${FILE_PATH} /S。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 uninstall_command 否 String 卸载命令(静默卸载命令)。 例: msiexec /uninstall ${FILE_PATH} /quiet。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 support_os 否 String 系统类型： Linux - Windows - Other - catalog_id 否 String 分类ID。 status 否 String 应用状态(正常、禁用) 'NORMAL' - 正常 'FORBIDDEN' - 禁用状态 install_info 否 String 安装信息。 表4 FileStoreLink 参数 是否必选 参数类型 描述 store_type 是 String 存储方式： OBS - OBS桶存储。 LINK - 外部存储,使用的可访问下载链接。 bucket_store 否 BucketStore object OBS桶存储。 file_link 否 String 文件下载完整路径。 表5 BucketStore 参数 是否必选 参数类型 描述 bucket_name 否 String 桶名称固定格式:wks-appcenter-{project_id}; 需先调用桶授权接口进行授权。 bucket_file_path 否 String OBS对象路径。 注: bucket_file_path是对象在obs中的完整路径,不能以/开头。 例如桶存在如下目录结构的数据。 Bucket: ├─dir1 | ├─object1.txt | └─object2.txt └─object3.txt Object1的路径: dir1/object1.txt Object2的路径: dir1/object2.txt Object3的路径: object3.txt

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 id String 唯一标识。 tenant_id String 租户id。 name String 应用名称。 version String 版本号。 description String 描述。 authorization_type String ALL_USER - 全部用户 ASSIGN_USER - 授权指定用户 app_file_store FileStoreLink object 应用存储信息。 app_icon_url String 应用图标路径。 install_type String 安装方式： QUIET_INSTALL - 静默安装。 安装命令(静默安装命令)，例: ${FILE_PATH} /S。 UNZIP_INSTALL - 解压安装。 例: unzip ${FILE_PATH}。 GUI_INSTALL - 用户通过GUI界面安装。 install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 install_command String 安装命令(静默安装命令)。 例: ${FILE_PATH} /S。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 uninstall_command String 卸载命令(静默卸载命令)。 例: msiexec /uninstall ${FILE_PATH} /quiet。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 support_os String 系统类型： Linux - Windows - Other - status String 应用状态(正常、禁用) 'NORMAL' - 正常 'FORBIDDEN' - 禁用状态 application_source String 应用来源： CUSTOM - 用户上传 SYSTEM - 内置应用 MARKET - 市场应用 create_time String 应用创建时间。 catalog_id String 分类ID。 catalog String 分类名称。 install_info String 安装信息。 表7 FileStoreLink 参数 参数类型 描述 store_type String 存储方式： OBS - OBS桶存储。 LINK - 外部存储,使用的可访问下载链接。 bucket_store BucketStore object OBS桶存储。 file_link String 文件下载完整路径。 表8 BucketStore 参数 参数类型 描述 bucket_name String 桶名称固定格式:wks-appcenter-{project_id}; 需先调用桶授权接口进行授权。 bucket_file_path String OBS对象路径。 注: bucket_file_path是对象在obs中的完整路径,不能以/开头。 例如桶存在如下目录结构的数据。 Bucket: ├─dir1 | ├─object1.txt | └─object2.txt └─object3.txt Object1的路径: dir1/object1.txt Object2的路径: dir1/object2.txt Object3的路径: object3.txt 状态码：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 错误描述。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 stop_num Integer 停止个数。 active_num Integer 运行中个数。 error_num Integer 故障个数。 hibernated_num Integer 休眠个数。 状态码：default 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询可用分区列表响应。 { "support_type" : [ "string" ], "default_type" : "string", "azs" : { "additionalProp1" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ], "additionalProp2" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ], "additionalProp3" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ] } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 result_list Array of DeleteTerminalsBindingDesktopsResult objects 需删除的策略ID列表。 表5 DeleteTerminalsBindingDesktopsResult 参数 参数类型 描述 id String 需删除的策略ID。 delete_result_code String 删除操作的结果码。 delete_result_msg String 删除操作的结果信息。 状态码：400 表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接口进行解密。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。