华为云用户手册

响应示例 状态码：200 成功响应。 { "count" : 0, "items" : [ { "name" : "user-file-persistent", "location" : "https://sfs-tmp.****.huawei.com:/sfs-tmp", "usage" : 1024, "create_time" : "2024-12-25T12:19:03.229Z" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of Sfs3Storage objects 存储列表。 表4 Sfs3Storage 参数 参数类型 描述 name String 文件系统名称。 location String 挂载地址。 usage String 存储使用量(Byte)。 create_time String 创建时间。 状态码：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 表4 响应Body参数 参数 参数类型 描述 resources Array of ResourceNoLimit objects 配额资源列表。 site_id String 站点ID。 表5 ResourceNoLimit 参数 参数类型 描述 type String 资源类别。 general_instances：普通桌面 Memory：内存 cores：CPU volumes：磁盘数量 volume_gigabytes：磁盘容量 gpu_instances：GPU桌面 deh：云办公主机 users：用户 policy_groups: 策略组 Cores: CPU(配额工具使用) quota Integer 配额数。 used Integer 配额已用值。 unit 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接口进行解密。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 function_configs Array of FunctionConfig objects 租户个性配置列表。 表5 FunctionConfig 参数 参数类型 描述 id String 功能配置id。 name String 功能配置名称。 status String 功能配置开关的状态，表示开启还是关闭 ON/OFF。 - ON： 开启该功能 - OFF： 关闭该功能。 values Array of MapObject objects 配置项列表，键值对格式。 表6 MapObject 参数 参数类型 描述 key String 配置项的键。 value String 配置项对应的值。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表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参数 参数 参数类型 描述 count Integer 总数。 状态码：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 错误描述。

URI GET /v1/{project_id}/app-server-sub-jobs/actions/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job详情的状态： WAITING - 等待 RUNNING - 运行中 SUC CES S - 成功 FAILED - 失败 ABNORMAL - 异常 ROLLBACK - 回滚中 ABORTING - 取消 job_type 否 String 任务类型，传入多个任务类型的时候将任务类型用英文逗号(,)进行分隔。 job_id 否 String 任务ID。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 quotas QuotaNoLimit object 配额信息。 site_quotas Array of SiteQuotaNoLimit objects 站点配额信息，暂不包括中心站点。 表4 QuotaNoLimit 参数 参数类型 描述 resources Array of ResourceNoLimit objects 配额资源列表。 表5 SiteQuotaNoLimit 参数 参数类型 描述 resources Array of ResourceNoLimit objects 配额资源列表。 site_id String 站点ID。 表6 ResourceNoLimit 参数 参数类型 描述 type String 资源类别。 general_instances：普通桌面 Memory：内存 cores：CPU volumes：磁盘数量 volume_gigabytes：磁盘容量 gpu_instances：GPU桌面 deh：云办公主机 users：用户 policy_groups: 策略组 Cores: CPU(配额工具使用) quota Integer 配额数。 used Integer 配额已用值。 unit String 配额单位。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表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 查询租户配额响应。 { "quotas" : { "resources" : [ { "type" : "general_instances", "quota" : 10, "used" : 3 }, { "type" : "volumes", "quota" : 500, "used" : 33 }, { "type" : "volume_gigabytes", "quota" : 21500, "unit" : "GB", "used" : 2090 }, { "type" : "cores", "quota" : 80, "used" : 10 }, { "type" : "Memory", "quota" : 100, "unit" : "GB", "used" : 19 }, { "type" : "gpu_instances", "quota" : 10, "used" : 0 }, { "type" : "users", "quota" : 3000, "used" : 29 }, { "type" : "policy_groups", "quota" : 10, "used" : 0 }, { "type" : "Cores", "quota" : 80, "used" : 0 } ] }, "site_quotas" : [ { "site_id" : 147258369, "resources" : [ { "type" : "gpu_instances", "quota" : 50, "used" : 0 }, { "type" : "ies_instances", "quota" : 500, "used" : 0 } ] } ] }

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

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

URI GET /v2/{project_id}/access-policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 access_control_type 否 String 接入策略控制类型 ACCESS_TYPE： 接入类型 IP_WHITE_LIST： IP白名单 limit 否 Integer 每页数量,范围0-100,默认100。 offset 否 Integer 偏移量,范围0-99,默认0。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 policies Array of AccessPolicyDetailInfo objects 查询接入策略响应。 total Integer 策略总数。 表5 AccessPolicyDetailInfo 参数 参数类型 描述 policy_name String 策略名。 blacklist_type String 黑名单类型，当前黑名单只支持互联网。 INTERNET： 互联网 access_control_type String 访问控制类型。默认为接入类型 ACCESS_TYPE： 接入类型 IP_WHITE_LIST： IP白名单 ip_list Array of IpInfo objects 策略的ip列表。 ip_total_count Integer 策略总数。 policy_id String 策略id。 create_time String 接入策略创建的时间。 表6 IpInfo 参数 参数类型 描述 ip_address String ip地址。 subnet_mask String 子网掩码。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 正常。 { "id" : "2c2be3fb-0013-48d5-a081-0731f3473997", "name" : "POOL2", "type" : "DYNAMIC", "description" : "string。", "created_time" : "2023-01-04T07:10:53.554Z", "charging_mode" : "1", "desktop_count" : 10, "desktop_used" : 5, "on_demand_desktop_num" : 0, "availability_zone" : "string", "subnet_id" : "string", "product" : { "product_id" : "workspace.x86.ultimate.large2", "flavor_id" : "s6.large.2", "type" : "BASE", "cpu" : "2", "memory" : "4096", "descriptions" : "尊享办公|2核|4GB内存。", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "80", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "sub_product_list" : [ ] }, "image_id" : "string", "image_name" : "string", "image_os_type" : "string", "image_os_version" : "string", "image_os_platform" : "string", "image_product_code" : "string", "root_volume" : { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" }, "data_volumes" : [ { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" } ], "security_groups" : [ { "id" : "string", "name" : "string" } ], "disconnected_retention_period" : 10, "enable_autoscale" : true, "autoscale_policy" : { "autoscale_type" : "AUTO_CREATED", "max_auto_created" : 1000, "min_idle" : 100, "once_auto_created" : 10 }, "status" : "STEADY", "enterprise_project_id" : "0", "in_maintenance_mode" : false, "desktop_name_policy_id" : "TEST" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 桌面池ID。 name String 桌面池名称。 type String 桌面池类型。DYNAMIC：动态池，STATIC：静态池。 description String 桌面池描述。 created_time String 创建时间，格式为：UTC格式，例如“2022-05-11T11:45:42.000Z”。 charging_mode String 计费模式，0：包周期，1：按需。 desktop_count Integer 桌面池总桌面数量。 desktop_used Integer 桌面池绑定用户的桌面个数。 availability_zone String 可用区。 subnet_id String 子网ID。 product ProductInfo object 产品信息。 image_id String 镜像ID。 image_name String 镜像名称。 image_os_type String 镜像OS类型。 image_os_version String 镜像OS版本。 image_os_platform String 镜像OS平台。 image_product_code String 镜像的productCode（specCode）。 root_volume VolumeInfo object 系统盘。 data_volumes Array of VolumeInfo objects 数据盘列表。 security_groups Array of SecurityGroup objects 桌面安全组。 disconnected_retention_period Integer 动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。 enable_autoscale Boolean 桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。 autoscale_policy AutoscalePolicy object 弹性伸缩策略。 status String 桌面池状态。 STEADY：稳态 TEMPORARY：临时态 EXIST_FROZEN：存在冻结桌面 UNKNOWN：未知态 enterprise_project_id String 企业项目ID。 in_maintenance_mode Boolean 桌面池是否处于管理员维护模式。 desktop_name_policy_id String 策略id，用于指定生成桌面名称策略。 表4 ProductInfo 参数 参数类型 描述 product_id String 产品ID。 flavor_id String 产品规格ID。 type String 产品类型。 BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 cpu String CPU。 memory String 内存。 descriptions String 产品描述。 charge_mode String 周期套餐标识，0表示包周期，1表示按需。 表5 VolumeInfo 参数 参数类型 描述 id String 批量操作磁盘的磁盘集合id。 type String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。 size Integer 磁盘容量，单位GB。 resource_spec_code String 规格。 表6 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 表7 AutoscalePolicy 参数 参数类型 描述 autoscale_type String 弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。 max_auto_created Integer 自动创建桌面上限。 min_idle Integer 空闲桌面低于多少时开始自动创建桌面。 once_auto_created Integer 一次自动创建桌面的数量。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 状态统计响应。 { "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 }, "desktop_pool_statistics" : [ { "desktop_pool_id" : 0, "desktop_pool_name" : 0, "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 } } ] }

URI GET /v2/{project_id}/statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 desktop_type 否 Array of strings 桌面类型。 statistics_type 否 Array of strings 统计类型，为空时仅统计桌面总数 |- - attach-state 按照分配状态统计 - login-state 按照登录状态统计 - run-state 按照运行状态统计。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 桌面总数。 attach_statistics AttachStatistics object 分配情况统计。 run_state_statistics DesktopRunStatisticsRsp object 运行情况统计。 login_state_statistics DesktopLoginStatisticsRsp object 登录情况统计。 desktop_pool_statistics Array of DesktopPoolStatistics objects 每个桌面池的情况统计，当desktop_type指定为POOL时返回。 表5 DesktopPoolStatistics 参数 参数类型 描述 desktop_pool_id String 桌面池id。 desktop_pool_name String 桌面池名称。 total_num Integer 桌面总数。 attach_statistics AttachStatistics object 分配情况统计。 run_state_statistics DesktopRunStatisticsRsp object 运行情况统计。 login_state_statistics DesktopLoginStatisticsRsp object 登录情况统计。 表6 AttachStatistics 参数 参数类型 描述 attached_num Integer 已分配个数。 unattached_num Integer 未分配个数。 attaching_num Integer 分配中个数。 attach_error_num Integer 分配失败的个数。 表7 DesktopRunStatisticsRsp 参数 参数类型 描述 stop_num Integer 停止个数。 active_num Integer 运行中个数。 error_num Integer 故障个数。 hibernated_num Integer 休眠个数。 表8 DesktopLoginStatisticsRsp 参数 参数类型 描述 in_use_num Integer 使用中。 unregistered_num Integer 未注册数目。 unable_to_connect_num Integer 未注册数目。 ready_num Integer 空闲数目。 disconnected_num Integer 断开连接数目。 状态码：default 表9 响应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 否 Integer 云办公带宽大小。 enterprise_project_id 否 String 企业项目ID，默认"0。" charge_mode 否 String 计费模式 wks_bandwidth：按带宽计费。 free: 不计费，不支持包周期订购。 wks_traffic：按流量计费

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

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

响应示例 状态码：200 正常。 { "script_execution_tasks" : [ { "id" : "string", "desktop_pool_id" : "string", "desktop_pool_name" : "string", "scripts" : [ { "id" : "string", "name" : "string" } ], "command_content" : "string", "command_type" : "string", "start_time" : "string", "end_time" : "string", "status" : "string", "success_num" : 0, "failed_num" : 0, "skip_num" : 0 } ], "total_count" : 0 }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 script_execution_tasks Array of ScriptExecutionTask objects 脚本执行任务列表。 total_count Integer 总数。 表5 ScriptExecutionTask 参数 参数类型 描述 id String 任务id。 desktop_pool_id String 桌面池id。 desktop_pool_name String 桌面池名称。 scripts Array of Script objects 脚本信息列表。 command_content String 执行的命令行。 command_type String 命令行类型。 POWERSHELL：WINDOWS系统使用。 BAT：WINDOWS系统使用。 SHELL：LINUX系统使用。 start_time String 任务开始时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 end_time String 任务结束时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 status String 任务状态，值含： FINISH：已完成。 FAILED：失败。 RUNNING：运行中。 INIT： 初始化。 success_num Integer 成功数量。 failed_num Integer 失败数量。 skip_num Integer 跳过数量。 表6 Script 参数 参数类型 描述 id String 脚本id。 name String 脚本名称。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表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接口进行解密。

URI GET /v2/{project_id}/desktop-pools/script-execution-tasks/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池id。 script_id 否 String 脚本id。 script_name 否 String 脚本名称。 status 否 String 执行情况。SUCCESS：成功，FAILED：失败，RUNNING：执行中，WAITING：等待。 task_type 否 String 查询的任务类型。支持SCRIPT、COMMAND。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回桌面数量限制。取值范围0-100，默认值是10。 execute_time_start 否 String 按执行时间查询的起始时间。指定该参数后，返回的结果为此时间之后的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。 execute_time_end 否 String 按执行时间查询的终止时间。指定该参数后，返回的结果为此时间之前的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。 task_id 否 Array of strings 任务id。

响应示例 状态码：200 查询登录信息响应。 { "total_count" : 4, "records" : [ { "computer_name" : "JY011", "user_name" : "jy01@local.com", "terminal_mac" : "00-ac-9c-c7-9a-df", "terminal_name" : "DESKTOP-EG0P3TR", "terminal_ip" : "8.5.60.58", "client_version" : "1.8.00005", "terminal_type" : "Windows 10", "agent_version" : "1.8.00005.10546", "desktop_ip" : "172.16.148.250", "connection_start_time" : "2020-04-24T03:02:47Z", "connection_setup_time" : "2020-04-24T03:02:49Z", "connection_end_time" : "2020-04-24T03:36:43Z", "is_reconnect" : false }, { "computer_name" : "JY011", "user_name" : "jy01@local.com", "terminal_mac" : "00-ac-9c-c7-9a-df", "terminal_name" : "DESKTOP-EG0P3TR", "terminal_ip" : "8.5.60.58", "client_version" : "1.8.00005", "terminal_type" : "Windows 10", "agent_version" : "1.8.00005.10546", "desktop_ip" : "172.16.148.250", "connection_start_time" : "2020-04-23T08:58:02Z", "connection_setup_time" : "2020-04-23T08:58:05Z", "connection_end_time" : "2020-04-23T22:45:00Z", "is_reconnect" : false } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 用户登录记录总数。 records Array of Record objects 用户登录记录。 表5 Record 参数 参数类型 描述 tenantId String 租户id，不对外展示。 sid String 桌面sid。 transaction_id String 事务id。 computer_name String 计算机名。 user_name String 用户名。 terminal_mac String 终端MAC地址。 terminal_name String 终端名称。 terminal_ip String 终端IP。 client_version String AccessClient版本。 terminal_type String 终端系统类型。 agent_version String AccessAgent版本。 desktop_ip String 桌面IP。 connection_start_time String 开始连接时间。 connection_setup_time String 建立连接时间。 connection_end_time String 结束连接时间。 is_reconnect Boolean 是否重连。 connection_failure_reason String 连接失败原因。 network_rtt Integer 网络时延ms。 e2e_rtt Integer 端到端时延 ms。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v2/{project_id}/connections/desktops 表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 登录桌面的终端系统类型，当前支持：WI（ 云桌面 客户端）。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回登录记录数量限制,取值范围0-1000。如果不指定，默认为20。 min_network_rtt 否 Integer 查询端到端时延的最小值。 max_network_rtt 否 Integer 查询端到端时延的最大值。

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

URI GET /v1/{project_id}/app-groups/{app_group_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 app_group_id 是 String 应用组ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]，默认值10。 offset 否 Integer 查询的偏移量，默认值0。 name 否 String 应用名称。 state 否 String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 app_id 否 String 应用ID。

响应示例 状态码：200 成功响应。 { "count" : 1, "items" : [ { "id" : "575772278315290631", "name" : "应用name2531691942", "version" : "V1.9202534394", "command_param" : "yQhK1urkWx0XR8ILGdSeFvqJYyMHURzP", "execute_path" : "C:\\Program Files (x86)\\Google应用\\appH7wqKcwpfk\\app0256aVegjU\\chrome.exe", "work_path" : "C:\\Users\\zhangssan\\AppData应用\\Local\\Google\\app5P521tF0RMkLrihaO0DR", "icon_path" : "C:\\Users\\zhangSan\\AppData\\Local应用\\Google\\appAXwSgdKA1FyDkbejBs2f.jpg", "icon_index" : 1499, "description" : "应用description256261241750805。", "app_group_id" : "575772274859184144", "state" : "NORMAL", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "publish_at" : "2023-06-06T14:13:58.914Z", "source_type" : 2, "publisher" : "tPPgWwxy5T130lX", "icon_url" : "", "sandbox_enable" : false, "is_pre_boot" : false } ] }

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