华为云用户手册

请求参数 表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 成功响应。 { "count" : 2, "items" : [ { "id" : "682367396442275840", "app_id" : "682367396387749888", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "WeChat", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_id" : "111", "version_name" : "000", "appfile_store_path" : "file/WeChatSetup_3.9.0.28.exe", "app_file_size" : "169179", "app_description" : "", "appicon_store_path" : "", "create_time" : "2024-03-26T06:16:57.321Z", "modify_time" : "2024-03-26T06:16:57.321Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAF4AAABdCAIAAACjJEaXAAAA*******BVHhe7Vt7jFzXWb/Peb929mXv2rt27PhtJ47rmKQhRG0d2tKkJAqgQEEFJFClAir8V6FWQhVB9E+Q4A/+KSBoVQRqqVQFopImEhQanKR2ahs7dtZee70Pr3d2Z+dxn/zO+e6cPffemd1ZZ7zeKPubq7O/77u/e+ec73zncWdmVd/3lS20w0poQFzXdRzH87yteKmAiAKCYhgG8S0AWvCXhyZgW+BYCQ3GUcC2wLESmq35JYKV0Gwhgq3QdMRWaDpiZfFeXl7OZrPEewhHcWt+o+43bd/2VXSFaipGSk1m1JSh6IFoU6LHobEV57ZXueXPTbozc/4CeNWvu77r+Vj/X CS pirdUVE3VTFXLq7l+tTis9Y9og9u0/rJW0DZTFvcmNA3fuu5OX/CuXnInZv1Kw2vaKrbVju07vmgs9gbg9G6IkIc4abqqI4lw5NRUv9a3Xx87ZDywXR1IILfuN95vaKp+7Yxz4Q3npwhNXbEcxELBc0ZrEqNwECKhkWIEv+qj0BGphGqMacOPGkce0Q/mtDQX3R/cfWiW/frr1luvWW/cVhYdz+7hfhEBNFRzQOt7KnHipHG4pOWCExuLuwkNZtb/tS98t/naTXfORZpg8mC97qv8BUGchJxriYmAmsggffsnk489bO5LKhs9xNYdmhvu3D80Xj5rXfL4kAgas1ZrQ861xDJBmdTMU4mjzyafwITN7I3COkLjKd7Lzf/+dv3VutcIXBuIYb3865lPHjP2IJUC1z1GV6FBJ8+5lW/WX/mR9Y6jOm27V7zifpC4M2KuQsQrrSU/k/zo6dTJvJphg/geY+3QYKtyyZn8++WX33UmMdeKmuJUi7JaBhRhZAOGU6mRguMFHtAO4oCsnGQGDUNsfB5LHvmV9Me26eV7vQlaIzRN3zpjX/rH5VduuLdZ9mwOHDDHfy1zer+xU1fvYXRWCw3i8j/WhX+q/XDCmfFVtjq3OpF3ZIfuDYxwRqxLHDlJBuMtFzR7jZHPZZ9+OLGX3/ueoGNoXMX7cePCt+qvXrWnsBixakGNFwfV9d6RuJ+w4vf9vYnR38l95qA5Rqd6jvahgeuSPfl31X9/237X9Vm+oE4oW53IXsxs1wYish6E8a7FRCJKAjMl2ZHErt8rPL/DGKCzvUX7sXrbrbzSePOsNWGxrxcUl23+VX4QCZmu73OisCdIxlUQWSDzlpiZcbGLfqBbtVGKaqzof9Kc+NbyD/EEF9S7p2iTNZbv/Ef97W9U/23OWVRVlQ0mAAQAJ49kOg17cXJh6cYiiJE2CztKxZ1FzdBDypaYlUCYOE3nzpX56lQFzxt6Qi+MlUrjZc3g3SaUBDJRApzktNTvFj79dPoj/HQv0SY0mHT/qvK9M9ZlnArSVwwKYbdS2m7a8xdm71yates2ywFdNVJGec/gwNFhzdSFUr4WvEXZKWfZufnGRHVqyWu4zKfiDmZpb3no2Iiu60JJL3Ef6YbK4eT4l0svDuklOHuI6IDCLuad5sRbzatoqKP4yGEkMy/pCHs8rzqzdPv/Zuxlm0KME3bNnjs/vTS95Hqwoteye2KOb5kYFLM/vbU4WXGbTnAH37eXLSRR5fqCSxWQ9HHiKMpVe+a1xjmasHqIaGjm3eoP6m83PAspQAf7KjPMhcex3NpU1anxuLDtID8w41juwuV5j6VRoMQhOJu+WqZdd5auL/gW5hv+9ig5cZft6vUK+xo1rG9LFp36f9bOz7gVfoueIRQaBP49e/onjfeomVRParXMhcd1vGatyboLowR3QkkEe6KlhoNOjV3LiGTics/x2CVUkRbBPa2G5TpsdYy8aZwgPtft2beaV/gtegaqUQBHcX/UuFjzLCwUqBVKfqCJER54UC1F5zNiDKrB9ojtrhWElT6bjoJLImBfOqsrytjlITLjLWEeqPvN4OJeIBSapmf/V/0i7xBMz8Ehm8SFRzG0VF9Ow249yAR+gChKZriIm8evZQQp0TLNbMrMJtjehV8VpAGu1PVEX8ZjX8lH37QtsT33qjMzaeNppmcIheaaM3fTnmdDmO1RgkM2iQsPUiYxnEkMpOUBhdqahWRmd8nXIYxeK0hgql7h4JCWbj0qouREL5iZXSVZGbk8Tm5at6/Zs/wuvUEoNO9Y1xq+Q3sqH7VmbytvsQQXHsUopkvHRlJDOYRJ1TXFUMEHHt+lZRJhpcxDN0mPFMsndhr5hGog/zTcJ1nO9J/caRTSYWXk8iiZdpZuuvM9XKeQkMG9sK/5s9p3vl89Q+a6gHjalbpbc/SsaRZTLEbrhO961tyy23T1tJnsz/BvZdaNF4tPfKH0qYyWDOz3h1Ab3rWmXaQLpk/Mf2wD4gcmJ+JUIJCUvqHpA5nkzqJeTns0AcuCsJgIK8X9URqqOZxPjheNoYynqXFlWO/pqpZTU2U9N6yXRrXyDqN/VO/XPX3ZxcaRDbGgSe8Doax5ZvbP570qONIy/hyIkh4FqZTN+CWyAETwbsRtlZqi8lhkB9V8Sc/2q/myls2r6ayaTCrYd2tQFrXceHIAWWPiKQODU9OwzKFk96Rni/UgFJonp7+KPSmZmwdpNTGml/fqw7uNoTF9YJtWGtaLcAanOwPPGRQaAJzM4FwXCIXm0ak/Zq5W7xFks/XYwl7yKSIRU+hBQs61xILk1dQhc/Sk+cABc3RM7y9pWVPVsDdGCwHsktFm1B8gwq5t/QSPBGTy4DAYHCAQrIlQaE7d+gpuR+b9hakah4ztTyePHUvsHNH6KEfQTpSocFtCDYmQiJICZJpmNwEKheYTMy/NO1XqNHQmnKx7W30IBKdanoAKJRwd+l/wbsRFNfPZ9COnk4cxfNJaQtQw0s4IIRmRVZQoaWSlUikECGYnhELz4uxfXmhOkXm/sNPo+2L29PHEeEFNUxzvBRAaZA2igwyiqMURSqpdyWEPscJmnZeCoAwO4sLTIlFlnEi8kxiex1MPfr344keT+/p09vxBDUBJtScTBGWckEwmqyhBMHXU6/VmsymSIwKmFjiYHMWWgA5X8XAIkw5AlDLxsO8QXPILEuLtxKjes6mHvpx7drcxaCrsEQP1YW4Oqh5AXDhlwk7HPLIpiCgRHYSmVqu1nWHRWUwEYEC9qU5+/vpfuxs+E2PgPJM++of5T2FJClwbCCRRIpHIZDKUTQKhrDmQ3D5g5FmvsucSdC97/CMzONDDohQETzCkEZdEBDJvJ/5Y+sCXCiwukbQHBAH4yejoEERoBOlSCSB3Go3oF/lMLZDT0h9J7UEWeYrK9+bY8rM1g4jgwiOdau+XBJ3EygFj+Pdzpws8X1jSh9Oe0JbH9XGPbAoiTEB4EB3LCn0zEQqNqeofzx1iS6uLLkZs+IdFvKQDVJQrhH1GyU2URCKCzuKEZ/5B/ultaoGfhpMhQuRydULoRklENl3XxaSDMohFJDS6oj2UHj+S3umxj5aQ9lg7aJ0KDuLCEyGd/G2dKJHJv5F77LA5wh55Oqc9THTp1NTU1atXZ2dnbdsWfqbuMExA0OaFhQVcNTExgWZD1klJfgQIaxZKUoam4Ww2W/Osv51//U+nv2sjbZBswT6Mf/rL1Csv2YwoA9oSsCtjYo199zjyteJzDxgD7HNCntioaJzMzMycPXt2enoaXYrd2rZt206ePJnP5+N6ApmI5rlz5y5fvoxhAg9m2aNHj+7duxd3EJr4HRBN3BmzMkxWJxkZLfFk7sDx9DjLNVzBPiViJR0RjzDb+mUiOEoiCcV4JvXQNq2AYDJHDJTn6LCLFy8iZRyHfRuD6ExOTiJSyB2uWgEbGFRlzq9cuUJxoXYhHc6cOYMo01mSATIHoER+EYmGBtidGHyh79SgWeT7MaYiEvBWuUJo/yYpo4J24v3m8PHkeFZnHzuhi6jTIgRYWlpaXFxEXcFpCODsjRs3EJq2egL0iCYNPYAECC4uJE8E8q0QLApom9DgseWp3MHTucNJ1URIWVTZksuIzOOkrZNI3H8qsXs7TxkAbiBCqKReFacA8IhT1hM6CdreTZREACzk4G1CA4wYpV8tP/5oeo+OKQKXtQ7cmOUFvwf1f6cjSBOuZyQsLqrpA8Z2scGjOomayWaOg/pTYGhoCM8+Qk+QTUwoAwMDNK0IIOmGh4dBZKXgRKhEBDFy24dGV7Vj6bHf7P/ZfclRmKydNGWwi1ulmD7IonmkRSLKwNkSj+nlYb2ABRE3hzfSchlYGXbv3l0ul2kdgbK/v//QoUPyQzN/tyhw1Y4dOxBBMjGz7t+/n0ITR6QOCA0bjOK+tEIRJyx7zX9ZOPP16e9fs+YCEf7gDlTKJhAhsoAgiX8hc+RL+Y+PG2VUiCpAhOpHRPhRyzt37mDZRp6jhkgHilQnPRGgWq1i3q1UKnAioIODg3jUjisjBCV4MplcuVE8NEDVa3xn4c2Xpv/1evMOW4axIdFaJcCJWI/ZhzBoOoqwgJEW52L187lTX8g92a+zn5GL2sSJADy0JGGMAKvrZT/6H7MvONJHjmYE8VvhXdoPKIGclnq+dOIr254bTw20PoUKSkGw/0Hr436ZCA4x5i/cln7+S/VAGScoBUGJtqEnaYAwUWe97MG4Q6ZgNImAUhknKGXSca6RgQXrs6XjfzH6uQPJEVzHlhg0EnOGIGwe4SZNK3FBWIx3N330CUtY9CpslHGCsyQgAieZXeqFP06EQJC4Ev61QwMkVeOJ/IP/vOeLT+X28RrydYo1jRPeXr4G8SAIv0RWOLsc6cNugwL9A5s6KkL4OwddSuAnu9ULf5wIgSBtlV2FBsBqghX9qyPP5fU02sSax1sYlNRg2SObMufftFm+gzK49aYEotNtaACoh0z21TRayIZHkC2cRMwYkbnjeVW3yf6LDHnUddoD/GS3euGPEyEQJK7EnL2O0AAX67cqXp21UWNHQPAYjUdqmPSQLfwSWeEQKP6sv1z1LZ65LKtXJ3LZDemJkq1oMLrHq9ULtoeHFwwMNBAx5oQHR2f/Bsem1hW/TARnmeNfd+bvuOwprrdADQP2vsG+qKI2dwPHd39QOY+kY3VAhmCP4mMO0vv03PHMrudLj/x84ciR9OioWe4zMmklYWAb01KSmBE2ISvv2rdvOYsIFXUUQIR3WECECTAFB3HhlAk73cFDpSDCBIRHEJQYTOxzCUSITrTd8sm43Jz5mfNfW3Sb6H62TfGVrGYezY49Vzr+Qt+JnYkyNLfsyrn6jfONqSuN2SmnMm8vL3tWU3Esz2G/B8Xb+kpC1ZN64rfSp04n96c25f8zIy59fX3rCM3fzL3+R9e+WVccjAm08cH00KcLR3+57+SxzA7MzYGoBcf36p5V85p33HrFqdV8u+FZSDhD1bNaoqRncp6ZqPmqg/EVdBdqEiEy4mc76btXCsgClIVCAaHoNjSu4v32e9/49u0f2747kiicLh55pvTwz+X2FfW7/Kda1/eWlpYa9Toe5FdviVyuIovo71qJlCmVSms/KAgggOjtATP3QvnESzt+6U9GfvHZ4kN3HRcAD/fpVErXOg4o1DJgLS574ojrO6GtkggClMlkEBfGxbnVswZTJmaQCWv+weTQrsSA0Yv/0cJb403xfEx1QBnpw7boUgbElWteggeuYrFIe5puQ0Ngawp/UOwV8BRXqVSanb943kggWcrlsviIZ32d3/OfLqA2uVwOmwjqTLYH7fDlCZxkyoTOttXHlYIIgSDkz+fz8idkzHt/gV5CdECQOLRJJ4JSJoSIPy7rRFAKwt1RghGD0URVIqxvQN0joA6NRgMjC+MrcG0gkC9oOLqH0kfg/mcNgKym+Y9tzzukPcnE2TghmUy6UaLEkhSPCxC17xdQy3Q6jQ0FmZTLKAnkBIgLp0zY6ZhHNgWRTQQFU0w8LsCmGFAyMPLn5+fjP+noObACYNeL/mgbF2CzZI0AKooVFIMLVRdpTwAHSBMnQiPI6spkMolRTM626HjiPgLVRZL39/dT1dEMOMUQ6BXotqtg0w0oGaibZVm1Wg2lw38OQE462yV4iqgYp4HdArIGuYkysGPY1KEhoIaIC/1qCgQLPNqJ1oKgJAERApmUbhiVtIvDJbhcXAJAgFkfyxOZcXwAQiNAMSJQgACqPxoMLiYOEEREACYuQXCRgLZt0+4JTgzbtss24YMUmghQcwqNaAKAdlLKBHYYiAuig+UPBCaWJ9pM0dkIPsChuTsgmhhZaCySCBHEaphItP8nmQ9daAgYXwgQyCrr92ZcvDcAGEQYTavs94APaWgATElAYLTDhzc0a2IrNB2xFZqO2ApNR2yFpiNWQrP6dP0hxMqWjz6dpZ9MbsAnSZscqVTq/wFA/8Sn/CbPxwAAAABJRU5ErkJggg==" }, { "id" : "662803789908017152", "app_id" : "662803789585055744", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "notepad", "app_category" : "GAME", "os_type" : "Windows", "version_id" : "v", "version_name" : "v", "appfile_store_path" : "file/npp_7.4.2_Installer.exe", "app_file_size" : "2979", "app_app_description" : "notepad。", "appicon_store_path" : "", "create_time" : "2024-02-01T06:38:10.049Z", "modify_time" : "2024-02-01T06:38:10.049Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACYAAAAgCAYAAAB+******rSURBVFhHpZdpbJRVFIYHYtToHxOioOxYFls" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of WarehouseApp objects 应用仓库中的应用列表。 表5 WarehouseApp 参数 参数类型 描述 id String 应用的记录id。 app_id String 应用id。 tenant_id String 租户id。 app_name String 应用名称。 app_category String 应用分类： GAME - 游戏 BUSSINESS_INTELLIGENCE - 商业智能 SECURE_STORAGE - 安全与存储 MULTIMEDIA_AND_CODING - 多媒体与编解码 PROJECT_MANAGEMENT - 项目管理 PRODUCTIVITY_AND_COLLABORATION - 生产力与协作 WEB_ADN_APPLICATION - 网页与应用开发 GRAPHIC_DESIGN - 图形设计 OTHER - 其它 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - version_id String 版本号。 version_name String 版本名称。 appfile_store_path String 应用文件的存放路径。 app_file_size String 应用文件的大小，以KB为单位。 app_description String 应用描述。 appicon_store_path String 应用文件的存放路径。 create_time String 应用创建时间。 modify_time String 应用修改时间。 verify_time String 应用审核时间。 verify_status String 审核状态： VERIFYING - 审核中 VERIFY_PASS - 审核通过 Verify_FAIL - 审核不通过 verify_comment String 审核的评论意见。 app_icon String app的图标文件。 状态码： 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}/app-warehouse/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]。 offset 否 Integer 查询的偏移量。 verify_status 否 String 审核状态。 app_id 否 String 应用仓库中的应用记录ID。 app_name 否 String 应用名称。 app_category 否 String 应用分类： GAME- 游戏。 BUSSINESS_INTELLIGENCE- 商业智能。 SECURE_STORAGE- 安全与存储。 MULTIMEDIA_AND_CODING- 多媒体与编解码。 PROJECT_MANAGEMENT- 项目管理, PRODUCTIVITY_AND_COLLABORATION- 生产力与协作。 WEB_ADN_APPLICATION- 网页与应用开发。 GRAPHIC_DESIGN- 图形设计。 OTHER- 其它。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 X-Language 否 String 语言： zh-cn：中文 en-us：英文 fr-fr: 法文 表3 请求Body参数 参数 是否必选 参数类型 描述 records 是 Array of strings 授权记录ID列表。

URI GET /v2/{project_id}/user-events 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 查询起始时间(0时区)。 end_time 否 String 查询结束时间(0时区)。 username 否 String 用户名（精确搜索）。 event_type 否 String 事件类型。 event_trace_id 否 String 事件之间的关联id。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回用户事件数量限制，取值范围0-1000。如果不指定，默认为100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 事件总数。 items Array of UserEventRsp objects 用户事件列表。 表5 UserEventRsp 参数 参数类型 描述 project_id String 项目id。 username String 用户名。 workspace_id String 企业id。 event_trace_id String 事件之间的关联id。 event_type String 事件类型。 event_time String 事件时间，UTC时间。 resource_type String 操作对象类型。 resource_id String 操作对象id。 resource_name String 操作对象名称。 client_type String 客户端类型。 client_ip String 客户端ip。 client_mac String 客户端mac地址。 source_ip String 操作用户源ip。 is_success Boolean 是否成功。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 响应成功。 { "count" : 0, "items" : [ { "project_id" : "xxx", "username" : "xxx", "workspace_id" : "xxx", "event_trace_id" : "407481bd-65b4-4de4-a553-67d858cbe29b", "event_type" : "loginByPassword", "event_time" : "1970-01-01T00:00:00Z", "resource_type" : "USER", "resource_id" : "407481bd-65b4-4de4-a553-67d858cbe29b", "resource_name" : "DESKTOP-01", "client_type" : "WINDOWS", "client_ip" : "127.0.0.1", "client_mac" : "xx.xx.xx.xx", "source_ip" : "127.0.0.1", "is_success" : true, "error_code" : "WKS.00000000", "error_msg" : "OK" } ]}

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "storage_claim_id" : 544959151881584640, "folder_path" : "shares/video/", "delimiter" : "/", "claim_mode" : "SHARE", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn-north-xx.myhuaweicloud.com:443" }, "policy_statement" : { "policy_statement_id" : "xxxxx-xxx-xx", "actions" : [ "GetObject" ] }, "attachment" : { "attach" : "USER001***@local.com", "attach_type" : "USER" } } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PersistentStorageAssignment objects 查询用户存储声明配置。 表5 PersistentStorageAssignment 参数 参数类型 描述 storage_claim_id String WKS存储目录声明ID。 folder_path String 存储对象路径。 注: path是对象在系统中的完整路径。 例如系统中存在如下目录结构的数据。 SFS-Tmp: └─shares ├─image └─video image的路径: shares/image/ video的路径: shares/video/ delimiter String 路径分隔符。 claim_mode String 存储声明的类型： USER - 用户目录 SHARE - 共享目录 storage_metadata StorageMetadata object 存储定义。 policy_statement PolicyStatement object 支持的访问策略。 attachment Attachment object 配置关联成员。 表6 StorageMetadata 参数 参数类型 描述 storage_handle String SFS文件系统名称。 storage_class String 存储类型： sfs - sfs3.0存储。 name String 名称。 region String 所在区域。 export_location String 访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。 表7 PolicyStatement 参数 参数类型 描述 policy_statement_id String 支持的访问策略，内置如下四种策略: DEFAULT_1：客户端访问存储 - 上传、下载; 云端访问存储 - 读写。 action: PutObject、DeleteObject、GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_2：客户端访问存储 - 下载; 云端访问存储 - 读写。 action: GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_3：客户端访问存储 - 上传; 云端访问存储 - 读写。 action: PutObject、DeleteObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_4：客户端访问存储 - 仅可查看列表,不允许上传下载; 云端访问存储 - 只读。 action: roam_action: GetObject actions Array of strings 客户端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 roam_actions Array of strings 云端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 表8 Attachment 参数 参数类型 描述 attach String 目标。 attach_type String 关联对象类型： USER - 用户 USER_GROUP - 用户组 状态码： 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}/persistent-storages/actions/list-attachments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 是 String WKS存储ID。 claim_mode 是 String 存储声明的类型，claim_mode为share时，storage_claim_id必填。 USER - 用户目录 SHARE - 共享目录 storage_claim_id 否 String WKS存储目录声明ID。 attach 否 String 成员。 attach_type 否 String 关联对象类型： USER - 用户 USER_GROUP - 用户组

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tc_bind_switch String 绑定开关，只取值ON或OFF。 tc_auto_bind_switch String 自动绑定开关，只取值ON或OFF。 tc_auto_bind_max Integer 最大绑定数量，默认值为1。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询云办公带宽列表响应。 { "bandwidths" : [ { "bandwidth_id" : "string", "bandwidth_name" : "string", "charge_mode" : "string", "size" : 0, "vpc_id" : "string", "vpc_name" : "string", "subnet_id" : "string", "subnet_name" : "string", "enterprise_project_id" : "string", "created_at" : "string", "order_id" : "string", "status" : "string", "control_mode" : "string" } ], "total_count" : 0}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 bandwidths Array of SubnetBandwidthDetail objects 云办公带宽信息。 total_count Integer 总数。 表5 SubnetBandwidthDetail 参数 参数类型 描述 bandwidth_id String 云办公带宽id。 bandwidth_name String 云办公带宽名称。 charge_mode String 云办公带宽计费方式。 size Integer 云办公带宽大小。 vpc_id String VPC ID。 vpc_name String VPC名称。 subnet_id String 子网 ID。 subnet_name String 子网名称。 enterprise_project_id String 企业项目ID。 created_at String 创建时间。 order_id String 订单id。 status String 状态。 CREATING：创建中。 ACTIVE：使用中。 INACTIVE：已停用。 UPDATING：更新中。 DELETING：删除中。 control_mode String 状态。 BLACK：黑名单管控模式。 WHITE：白名单管控模式。 状态码： default 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/bandwidths 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回桌面数量限制。如果不指定，则返回所有符合条件的记录。 vpc_id 否 String vpc id。 subnet_id 否 String 子网id。 bandwidth_id 否 String 云办公带宽id。 bandwidth_name 否 String 云办公带宽名称。

响应示例 状态码： 200 查询策略组策略项信息的响应。 { "policies" : { "peripherals" : { "usb_custom_policy_debug" : "string", "usb_port_redirection" : { "usb_enable" : true, "options" : { "usb_image_enable" : true, "usb_video_enable" : true, "usb_printer_enable" : true, "usb_storage_enable" : false, "wireless_devices_enable" : false, "network_devices_enable" : false, "usb_smart_card_enable" : true, "other_usb_devices_enable" : false, "usb_redirection_customization_policy" : "string", "usb_redirection_mode" : "Common mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "mobile_printer_enable" : false, "print_data_compression_mode" : false, "sync_client_default_printer_enable" : true, "universal_printer_driver" : "Default" } }, "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "string" } }, "camera_redirection" : { "video_compress_enable" : true, "options" : { "camera_frame_rate" : 15, "camera_max_width" : 3000, "camera_max_heigth" : 3000, "camera_compression_method" : "H.264" } }, "twain_redirection_enable" : true, "image_compression_level" : "medium", "hid_redirection" : { "hid_redirection_enable" : false, "options" : { "hid_redirection_customization_policy" : "string" } } }, "usb_device_common" : { "pcsc_smart_card_enable" : "Disable", "common_options" : { "remove_smart_card_disconnect_enable" : false } }, "serial_port_redirection" : { "serial_port_enable" : false, "options" : { "auto_connect_enable" : false } }, "parallel_port_redirection" : { "parallel_port_enable" : false }, "driver_interface_redirection" : { "api_redir_driver_list" : "string" } }, "audio" : { "audio_redirection_enable" : true, "play_volume" : "Do Not Set Volume", "play_volume_ratio" : "Do Not Set Volume Ratio", "record_volume" : "100", "record_volume_ratio" : "Do Not Set Volume Ratio", "audio_transmission_mode" : "Reliable Transmission", "play_redirection_enable" : true, "play_classification" : "Music Play", "play_quality" : "Middle", "play_denoising" : "Disable Denoising", "play_agc" : "Disable AGC", "play_crc" : "Disable CRC", "play_device_mode" : "Play Device In Shared Mode", "play_delay_threshold" : "240", "play_amplitude_threshold" : "4096", "play_prefill_data" : "Do Not Prefill Data", "record_redirection_enable" : true, "record_classification" : "Speech Call", "record_quality" : "Middle", "record_denoising" : "-25", "record_agc" : "Disable AGC", "record_crc" : "Disable CRC", "record_device_mode" : "Record Device In Shared Mode", "record_delay_threshold" : "200", "record_amplitude_threshold" : "4096" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "autoclose_monitor_after_locked" : false, "autoclose_monitor_options" : { "autoclose_monitor_wait_time" : 300 }, "forbid_screen_capture" : false, "client_machine_join_domain" : true, "client_type" : { "client_type_limit" : true, "options" : { "sc_type_window" : true, "sc_type_mac" : true, "sc_type_android" : true, "sc_type_linux" : true, "sc_type_h5" : true, "sc_type_ios" : true, "sc_type_harmony_os" : true, "tc_type_all" : true } } }, "display" : { "display_level" : "LEVEL4", "options" : { "display_bandwidth" : 20000, "frame_rate" : 25, "video_frame_rate" : 30, "min_image_cache" : 200, "smoothing_factor" : 60, "lossless_compression_mode" : "Basic Compression", "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "lossy_compression_quality" : 85, "color_enhancement_enable" : false, "quality_bandwidth_first" : "Quality First", "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "peak_video_bit_rate" : 18000, "video_quality_options" : { "average_video_quality" : 15, "lowest_video_quality" : 25, "highest_video_quality" : 7 }, "gop_size" : 100, "encoding_preset" : "Preset 1" }, "rendering_acceleration_enable" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : true, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false, "video_recognition_threshold" : 10, "frame_rate_statistical_length" : 4, "image_quality_threshold" : 0, "refresh_frequency_threshold" : 3, "exiting_video_area_threshold" : 8, "min_video_width" : 191, "min_video_length" : 191, "single_frame_natural_percentage" : "0.3", "cyclical_natural_images_number" : 2, "non_natural_image_percentage" : "0.85", "non_natural_images_number" : 25 }, "adaptive_bitrate_control_enable" : false, "adaptive_bitrate_control_options" : { "peak_bandwidth_suppression_enable" : false, "expected_average_network_latency" : 160, "network_latency_threshold1" : 160, "network_latency_threshold2" : 300, "min_dynamic_frame_rate" : 17, "min_dynamic_frame_rate_lv1" : 17, "min_dynamic_frame_rate_lv2" : 10, "rtt_threshold" : 20, "min_add_framerate" : 8, "max_add_framerate" : 20, "sub_framerate" : 25, "adaptive_bandwidth_lower_limit" : 500, "adaptive_compression_quality_lower_limit" : 60, "adaptive_compression_quality_upper_limit" : 85, "adaptive_compression_quality_increase_limit" : 5, "adaptive_compression_quality_decrease_limit" : 10, "adaptive_average_quality_lower_limit" : 15, "adaptive_average_quality_upper_limit" : 25, "adaptive_average_quality_increase_limit" : 3, "adaptive_average_quality_decrease_limit" : 1, "adaptive_min_quality_lower_limit" : 25, "adaptive_min_quality_upper_limit" : 30, "adaptive_min_quality_increase_limit" : 3, "adaptive_min_quality_decrease_limit" : 1 }, "video_card_memory_size" : 64, "configuration1_enable" : false, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false, "application_recognition" : "string", "duplicate_display_enable" : false, "default_mapping_order" : "1,2,3,4", "duplicate_display_mode" : "One-to-One" }, "file_and_clipboard" : { "file_redirection" : { "redirection_mode" : "DISABLED", "options" : { "fluid_control_switch_enable" : false, "fluid_control_options" : { "good_network_latency" : 30, "normal_network_latency" : 70, "poor_network_latency" : 100, "reducing_step" : 20, "slow_increasing_step" : 10, "quick_increasing_step" : 20, "start_speed" : 1024, "test_block_size" : 64, "test_time_gap" : 10000 }, "compression_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "linux_file_size_supported_enable" : true, "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 }, "linux_root_mount_switch_enable" : true, "linux_root_dir_list" : "\\\\var\\\\log", "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_fixed_drive_file_system_format" : "string", "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir|lifs", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "path_separator" : "|", "fixed_drive_enable" : true, "removable_drive_enable" : true, "cd_rom_drive_enable" : true, "network_drive_enable" : true }, "vm_send_file_client" : true, "redirection_send_file_options" : { "read_write_speed" : 0 } }, "clip_length_limit_flag_c2s" : true, "clip_length_limit_c2s" : 180, "clip_length_limit_flag_s2c" : true, "clip_length_limit_s2c" : 180, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "clipboard_file_redirection_enable" : true } }, "access_control" : { "ip_access_control" : "string" }, "session" : { "vdi" : { "auto_lock_enable" : true, "auto_lock_options" : { "auto_lock_minutes" : 10, "auto_disconnect" : "DISABLED", "options" : { "auto_disconnect_minutes" : 1440 } }, "disconnect_logout_enable" : 0, "disconnect_logout_options" : { "disconnect_logout_minutes" : 10 }, "disconnect_hibernate_enable" : false, "disconnect_hibernate_options" : { "disconnect_hibernate_minutes" : 0 }, "no_operation_hibernate_enable" : false, "no_operation_hibernate_options" : { "no_operation_hibernate_minutes" : 0 } }, "self_help_console" : true, "disconnect_on_lock_flag" : false }, "bandwidth" : { "intelligent_data_transport_flag" : "DISABLE", "total_bandwidth_control_enable" : false, "options" : { "total_bandwidth_control_value" : 30000, "display_bandwidth_percentage_enable" : false, "display_bandwidth_percentage_options" : { "display_bandwidth_percentage_value" : 65 }, "multimedia_bandwidth_percentage_enable" : false, "multimedia_bandwidth_percentage_options" : { "multimedia_bandwidth_percentage_value" : 50 }, "usb_bandwidth_percentage_enable" : false, "usb_bandwidth_percentage_options" : { "usb_bandwidth_percentage_value" : 100 }, "pcsc_bandwidth_percentage_enable" : false, "pcsc_bandwidth_percentage_options" : { "pcsc_bandwidth_percentage_value" : 5 }, "twain_bandwidth_percentage_enable" : false, "twain_bandwidth_percentage_options" : { "twain_bandwidth_percentage_value" : 15 }, "printer_bandwidth_percentage_enable" : false, "printer_bandwidth_percentage_options" : { "printer_bandwidth_percentage_value" : 5 }, "com_bandwidth_percentage_enable" : false, "com_bandwidth_percentage_options" : { "com_bandwidth_percentage_value" : 3 }, "file_redirection_bandwidth_percentage_enable" : false, "file_redirection_bandwidth_percentage_options" : { "file_redirection_bandwidth_percentage_value" : 30 }, "clipboard_bandwidth_percentage_enable" : false, "clipboard_bandwidth_percentage_options" : { "clipboard_bandwidth_percentage_value" : 3 }, "secure_channel_bandwidth_percentage_enable" : false, "secure_channel_bandwidth_percentage_options" : { "secure_channel_bandwidth_percentage_value" : 30 }, "camera_bandwidth_percentage_enable" : false, "camera_bandwidth_percentage_options" : { "camera_bandwidth_percentage_value" : 30 }, "virtual_channel_bandwidth_percentage_enable" : false, "virtual_channel_bandwidth_percentage_options" : { "virtual_channel_bandwidth_percentage_value" : 65 } }, "display_bandwidth_control_enable" : false, "display_bandwidth_control_options" : { "display_bandwidth_control_value" : 20000 }, "multimedia_bandwidth_control_enable" : false, "multimedia_bandwidth_control_options" : { "multimedia_bandwidth_control_value" : 15000 }, "usb_bandwidth_control_enable" : false, "usb_bandwidth_control_options" : { "usb_bandwidth_control_value" : 30000 }, "pcsc_bandwidth_control_enable" : false, "pcsc_bandwidth_control_options" : { "pcsc_bandwidth_control_value" : 2000 }, "twain_bandwidth_control_enable" : false, "twain_bandwidth_control_options" : { "twain_bandwidth_control_value" : 5000 }, "printer_bandwidth_control_enable" : false, "printer_bandwidth_control_options" : { "printer_bandwidth_control_value" : 2000 }, "com_bandwidth_control_enable" : false, "com_bandwidth_control_options" : { "com_bandwidth_control_value" : 1000 }, "file_redirection_bandwidth_control_enable" : false, "file_redirection_bandwidth_control_options" : { "file_redirection_bandwidth_control_value" : 10000 }, "clipboard_bandwidth_control_enable" : false, "clipboard_bandwidth_control_options" : { "clipboard_bandwidth_control_value" : 1000 }, "secure_channel_bandwidth_control_enable" : false, "secure_channel_bandwidth_control_options" : { "secure_channel_bandwidth_control_value" : 10000 }, "camera_bandwidth_control_enable" : false, "camera_bandwidth_control_options" : { "camera_bandwidth_control_value" : 10000 }, "virtual_channel_bandwidth_control_enable" : false, "virtual_channel_bandwidth_control_options" : { "virtual_channel_bandwidth_control_value" : 20000 } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "watermark" : { "watermark_enable" : false, "options" : { "show_style" : "RANDOM", "color" : "2a2a2a", "font_size" : 30, "opacity_setting" : "12.5", "content_item_count" : 1, "display_format" : "{\"AlignMode\":\"left\",\"DateTimeFormat\":\"DT\",\"DateFormat\":\"yyyy-mm-dd\",\"TimeFormat\":\"hh:mm:ss\",\"RepeatCount\":2,\"RepeatInterval\":10,\"DisplayFormat\":{\"Content1\":\"CustomContent\",\"Interval1\":\"n\",\"Content2\":\"UserName\",\"Interval2\":\"4\",\"Content3\":\"DateTime\"}}", "lean" : -45, "content_customized" : "string", "content_color" : 522857002, "watermark_security_access" : false, "user_extend_info_switch" : false, "user_extend_info" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false, "selfhelp_console_enable" : true, "client_mouse_send_interval" : 30, "windows_client_keyboard_mode" : "GLOBAL", "windows_client_mouse_mode" : "WINDOW", "linux_client_keyboard_mode" : "EVENT", "linux_client_mouse_mode" : "EVENT", "special_keyboard" : false, "joy_stick_flag" : false }, "seamless" : { "seamless_enable" : false, "options" : { "seamless_apply_path" : "string" } }, "personalizedDataMgmt" : { "personalized_data_mgmt_path" : "string", "user_data_roaming_enable" : false, "user_data_roaming_options" : { "profile_streaming_enable" : false, "roamed_files_local_path" : "string", "exclude_folders_path" : "string", "roaming_registry_method" : "string", "roaming_registry_path" : "string" }, "user_folder_redirection_enable" : false, "user_folder_redirection_options" : { "restore_local_directories_enable" : false, "appData_roaming_enale" : false, "redirec_desktop" : false, "redirec_start_menu" : false, "redirec_documents" : false, "redirec_pictures" : false, "redirec_music" : false, "redirec_videos" : false, "redirec_favorites" : false, "redirec_contacts" : false, "redirec_downloads" : false, "redirec_links" : false, "redirec_searches" : false, "redirec_saved_games" : false }, "logoff_delete_user_configuration" : false, "network_drive_mapping_enable" : false, "network_drive_mapping_options" : { "network_drive_mapping_path" : "string", "drive_letter" : "string" } }, "custom" : { "custom_configuration1_enable" : false, "options" : { "custom_configuration1_rule" : "string" } }, "record_audit" : { "enable" : true, "rules" : { "rule" : { "record_type" : "string", "interval_record_start_time" : "string", "interval_record_end_time" : "string", "op_type" : "string", "audio_record" : true, "fps" : 0, "duration" : 0, "resolution" : "string", "retention_duration" : 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" } ]}

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 正常。 { "tasks_records" : [ { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "start_time" : "2022-12-31 09:00:00", "task_type" : "START", "scheduled_type" : "FIXED_TIME", "status" : "SUC CES S", "success_num" : 1, "failed_num" : 1, "skip_num" : 1, "time_zone" : "Asia/Shanghai", "execute_task_id" : "string", "execute_object_type" : "string" } ], "total_count" : 10}

URI GET /v2/{project_id}/scheduled-tasks/{task_id}/records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 task_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回桌面数量限制。取值范围0-100，默认值是10。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 tasks_records Array of ScheduledTasksRecords objects 定时任务执行记录列表。 total_count Integer 总个数。 表5 ScheduledTasksRecords 参数 参数类型 描述 id String 任务执行记录id。 start_time String 执行时间，格式为yyyy-MM-dd HH:mm:ss。 task_type String 任务类型。START：开机，STOP：关机，REBOOT：重启，HIBERNATE：休眠，REBUILD：重建系统盘。 scheduled_type String 执行周期类型。FIXED_TIME：指定时间，DAY：按天，WEEK：按周，MONTH：按月。 status String 本次执行状态。 success_num Integer 成功桌面个数。 failed_num Integer 失败桌面个数。 skip_num Integer 跳过桌面个数。 time_zone String 时区。 execute_task_id String 执行定时任务的任务id，只有定时执行脚本返回。 execute_object_type String 执行定时任务的对象类型，只有定时执行脚本返回。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询产品列表响应。 { "os_type" : "string", "architecture" : "string", "availability_zone" : "string", "products" : [ { "product_id" : "string", "flavor_id" : "string", "type" : "string", "architecture" : "string", "cpu" : "string", "cpu_desc" : "string", "memory" : "string", "is_gpu" : true, "system_disk_type" : "SAS", "system_disk_size" : "80", "data_disk_size" : "80", "gpu_desc" : "string", "bill_switch" : "on", "descriptions" : "string。", "product_desc" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "charge_mode" : "st", "contain_data_disk" : true, "resource_type" : "string", "cloud_service_type" : "string", "volume_product_type" : "string", "domain_ids" : [ "string" ], "status" : "normal", "sub_product_list" : [ "string" ], "package_type" : "string", "series_type" : "string", "name" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "default_desktop_num" : 4, "max_apply_desktop_num" : 14, "share_space_size" : 100 } ], "total_count" : 0}

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。 package_type 否 String 套餐系列。 limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量，默认0。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 os_type String 套餐所支持操作系统类型。请求参数有os_type时，才有此参数。 architecture String 产品架构。请求参数有package_type=agile时，才有此参数。 availability_zone String 可用分区。请求参数有availability_zone时，才有此参数。 products Array of Product objects 产品列表。 total_count Integer 对象总数。 表5 Product 参数 参数类型 描述 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 错误描述。 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接口进行解密。

响应参数 状态码： 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 成功响应。 { "id" : "1", "name" : "流程开发应用组", "app_server_group_id" : "1", "app_server_group_name" : "XXX应用服务器组", "description" : "XXX公司 软件开发应用组。", "authorization_type" : "APP_GROUP", "tenant_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "app_type" : "SESSION_DESKTOP_APP", "create_at" : "2022-03-07T10:40:43.858Z", "app_count" : 10, "app_server_group_app_server_group_description" : "应用服务器组XXXXX。"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 应用组ID。 name String 应用组名称。 app_server_group_id String 应用服务器组ID。 app_server_group_name String 应用服务器组名称。 description String 应用组描述。 authorization_type String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 tenant_id String 租户ID。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。 create_at String 发布时间。 app_count Integer 应用数量。 app_server_group_description 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 错误描述。 状态码： 409 表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 表3 响应Body参数 参数 参数类型 描述 latest_version String 租户的HDA最新版本。 状态码： 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 错误描述。 状态码： 409 表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 错误描述。