华为云用户手册

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

响应示例 状态码： 200 查询策略应用对象的响应。 { "targets" : [ { "target_id" : "S-1-5-21-1065092785-1316984780-3147557180-9999", "target_type" : "USER", "target_name" : "All-Targets-123" }, { "target_id" : "192.168.1.1", "target_type" : "CLIENTIP", "target_name" : "192.168.1.1" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 targets Array of Target objects 应用对象列表。 表5 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 APPGROUP：应用组。 target_id：应用组id。 target_name：应用组名称。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 ALL：表示所有。 target_id：default-apply-all-targets。 target_name：All-Targets。 状态码： 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 /v1/{project_id}/policy-groups/{policy_group_id}/target 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 policy_group_id 是 String 策略组id。 表2 Query参数 参数 是否必选 参数类型 描述 target_type 否 String 应用对象的类型： USER：表示用户。 USERGROUP：表示用户组。 APPGROUP：应用组。 OU：组织单元。 ALl：所有类型

URI GET /v2/{project_id}/script-execution-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 resource_id 否 Array of strings 执行脚本的资源ID列表。 resource_group_id 否 Array of strings 执行脚本的资源组ID。 script_id 否 Array of strings 执行的脚本ID。 script_name 否 Array of strings 执行的脚本名称。 status 否 String 执行脚本的执行情况。 is_first_order 否 Boolean 是否首批执行。 script_task_id 否 String 执行脚本的任务ID。 task_type 否 String 执行记录的任务类型(SCRIPT/COMMAND)。 show_history 否 Boolean 是否查询历史记录，默认为false，为true时需要同时传入resource_id与script_id。 execute_time_start 否 String 按执行时间查询的起始时间。指定该参数后，返回的结果为此时间之后的所有执行记录。时间格式如：“2021-10-01T12:00:00Z”。 execute_time_end 否 String 按执行时间查询的终止时间。指定该参数后，返回的结果为此时间之前的所有执行记录。时间格式如：“2021-10-01T12:00:00Z”。

响应示例 状态码： 200 成功响应。 { "count" : 0, "script_records" : [ { "id" : "sawafaw12414214awfa", "script_id" : "string", "script_name" : "string", "script_task_id" : "string", "resource_id" : "string", "resource_name" : "string", "resource_type" : "string", "start_time" : "2024-12-25T07:10:49.357Z", "end_time" : "2024-12-25T07:10:49.357Z", "status" : "string", "execute_order" : 0, "command_content" : "string", "command_type" : "string", "result_code" : "string", "reason" : "string" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 script_records Array of ScriptRecordSimpleInfo objects 脚本执行记录列表。 表5 ScriptRecordSimpleInfo 参数 参数类型 描述 id String 脚本执行记录ID。 script_id String 脚本ID。 script_name String 脚本名称。 script_task_id String 脚本执行的任务ID。 resource_id String 执行脚本的资源ID，如桌面ID。 resource_name String 执行脚本的资源名称，如桌面名称。 resource_type String 资源类型，如桌面(DESKTOP)。 start_time String 脚本执行开始时间。 end_time String 脚本执行结束时间。 status String 脚本执行状态。 execute_order Integer 执行批次（默认：0，灰度：1，非灰度：2）。 result_code String 错误码。 reason String 原因。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 0, "items" : [ { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "execute_id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "server_id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "server_name" : "APS-WKSAPP1", "status" : "WAITING", "task_type" : "RESTART_SERVER", "time_zone" : "Asia/Shanghai", "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "result_code" : "WKS.00129901", "result_message" : "The service is now unavailable to process the request." } ]}

URI GET /v1/{project_id}/schedule-task/{execute_history_id}/execute-detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 execute_history_id 是 String 定时任务唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ScheduleTaskExecuteDetail objects 服务器组列表，返回列表条目数量上限为分页的最大上限值。 表5 ScheduleTaskExecuteDetail 参数 参数类型 描述 id String 定时任务执行记录主键id。 execute_id String 主任务记录id。 server_id String 操作的server_id。 server_name String 操作的机器名称。 status String job状态： WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 task_type String 定时任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 time_zone String 时区。 begin_time String 子任务开始时间。 end_time String 子任务结束时间。 result_code String 任务执行失败时的错误码。 result_message String 任务失败原因。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 unused_desktops Array of UnusedDesktopInfo objects 指定时间段内未使用桌面列表。 total_count Integer 总数。 表5 UnusedDesktopInfo 参数 参数类型 描述 desktop_id String 桌面id。 compute_name String 桌面名称。 create_time String 桌面创建时间。 disconnect_time String 最近一次断连时间。 状态码： default 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询在指定时间段未使用的桌面响应。 { "unused_desktops" : [ { "desktop_id" : "e0367f84-1d64-498e-9b92-093002ac3ce8", "compute_name" : "ZYZ08", "create_time" : "2022-08-08T02:34:05.202Z", "disconnect_time" : "2022-08-08T02:39:00.000Z" }, { "desktop_id" : "b8eb2ac0-4540-4409-857f-df5e2de07546", "compute_name" : "wangyan8301", "create_time" : "2022-08-08T02:34:05.202Z", "disconnect_time" : "2022-08-08T02:39:00.000Z" } ], "total_count" : 2}

URI GET /v2/{project_id}/desktops/statistics/unused 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2000，默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-2000，默认值1000。 start_time 否 String 开始时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。 end_time 否 String 结束时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PolicyStatement objects 支持的访问策略。 表5 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 - 删除。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 4, "items" : [ { "policy_statement_id" : "DEFAULT_4", "actions" : null, "roam_actions" : [ "GetObject" ] }, { "policy_statement_id" : "DEFAULT_3", "actions" : [ "PutObject", "DeleteObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] }, { "policy_statement_id" : "DEFAULT_2", "actions" : [ "GetObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] }, { "policy_statement_id" : "DEFAULT_1", "actions" : [ "PutObject", "DeleteObject", "GetObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] } ]}

响应示例 状态码： 200 查询站点信息的接口。 { "site_infos" : [ { "site_id" : "string", "site_name" : "string", "site_type" : "string", "project_id" : "string", "status" : "string", "create_time" : "string", "agent_info" : [ { "id" : "string", "project_id" : "string", "site_id" : "string", "vag_ip" : "string", "private_ip" : "string", "private_ipv6" : "string", "vag_port_id" : "string", "ssh_user" : "gandalf", "ssh_pwd" : "string", "vm_id" : "string", "name" : "string", "internal_ip" : "string", "internal_ipv6" : "string", "internal_port_id" : "string", "external_ip" : "string", "external_id" : "string", "root_user" : "string", "root_pwd" : "string", "status" : "string", "availability_zone" : "string", "create_time" : 255, "create_time_str" : "string", "state" : "string", "number_of_online_user" : 20000, "running_status" : "string", "domain_id" : "string", "version" : "string", "latest_version" : "string", "access_edge_version" : "string", "tenant_lock" : 0, "resource_pool_id" : "string", "role" : "string", "resource_pool_type" : "string", "edge_sk" : "string", "has_heartbeat" : true, "user_count" : 0 } ] } ], "total_count" : 200000}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 site_infos Array of SiteInfo objects 站点信息列表。 total_count Integer 站点总数。 表5 SiteInfo 参数 参数类型 描述 site_id String 站点id。 site_name String 站点名字。 site_type String 配置状态。 CENTER： 中心初始化 IES： 边缘初始化 project_id String 项目ID。 status String 站点状态。 create_time String 创建时间。 agent_info Array of Vag objects 网关节点信息。 表6 Vag 参数 参数类型 描述 id String vAG信息ID。 project_id String 项目ID。 site_id String 站点ID。 vag_ip String vAG IP，与管理节点相同的IP。 private_ip String vAG内网IP，HDA往这个IP上报心跳。 private_ipv6 String vAG内网IPv6。 vag_port_id String vAG端口ID，与管理节点相同的端口的ID。 ssh_user String SSH用户的名称，固定为gandalf。 ssh_pwd String SSH用户的密码。 vm_id String vAG所属E CS 的ID。 name String vAG所属机器名。 internal_ip String vAG内部通信IP，最终租户VPC的子网IP。 internal_ipv6 String vAG内部通信IPV6。 internal_port_id String vAG内部通信端口ID，最终租户VPC的子网中端口的ID。 external_ip String 外部通信IP，可能独立的EIP。 external_id String 外部通信ID，可能独立的EIP ID。 root_user String root用户的名称，固定为root。 root_pwd String root用户的密码。 status String vag操作状态。 availability_zone String 可用分区。 create_time Long 创建时间。 create_time_str String 创建时间字符串。 state String vag服务状态 NOT_USE：维护，ON_USE：启用，CANCELLATION：退服。 number_of_online_user Long 在线用户数。 running_status String vag运行状态。 domain_id String 租户侧domainId。 version String vag当前版本号。 latest_version String vag最新版本号。 access_edge_version String wksAccessEdge版本号。 tenant_lock Integer 项目是否被锁定 0是未锁定 1是锁定。 resource_pool_id String 资源池id。 role String agent角色，如：vag,vap4down,vap4up,authConnector。 resource_pool_type String 资源池类型，public,private。 edge_sk String 边缘sk。 has_heartbeat Boolean 是否有心跳。 user_count Integer VAG负载个数。 状态码： 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接口进行解密。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v1/{project_id}/persistent-storages/actions/list-share-folders 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 是 String WKS存储ID。 storage_claim_id 否 String WKS存储目录声明ID。 path 否 String 查询名称需满足如下规则: 可见字符+空格。 长度0~128个字符。

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "storage_claim_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "folder_path" : "shares/video/", "delimiter" : "/", "claim_mode" : "SHARE", "count" : { "USER" : 0, "USER_GROUP" : 1 } } ]}

URI GET /v2/{project_id}/policy-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 用于分页查询，返回策略组数量的限制。如果不指定，则返回所有符合条件的策略组。范围0~100。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 policy_group_id 否 String 根据策略组ID过滤结果。 policy_group_name 否 String 根据策略组名字过滤结果。 priority 否 Integer 根据优先级过滤结果。所带的值需要满足现有策略组已有最大优先级值。 update_time 否 String 根据更新时间过滤结果。时间格式满足：yyyy-MM-dd HH:mm:ss。 description 否 String 策略组描述。 is_group_name_accurate 否 Boolean 策略组名字精确查询。

响应示例 状态码： 200 查询策略组信息的响应。 { "total_count" : 2, "policy_groups" : [ { "priority" : 1, "description" : "策略组描述1。", "policy_group_id" : "8ac225c2781f230a01781f29b2e7xxxx", "policy_group_name" : "策略组1", "update_time" : "2021-03-12 12:02:01" }, { "priority" : 2, "description" : "策略组描述2。", "policy_group_id" : "8ac225c2781edb0d01781edde3f4xxxx", "policy_group_name" : "策略组2", "update_time" : "2021-03-12 09:06:44" } ]}

响应示例 状态码： 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 } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of App objects 查发布的应用列表。 表5 App 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 状态码： 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 /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]。 offset 否 Integer 查询的偏移量。 name 否 String 应用名称。 state 否 String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 app_id 否 String 应用ID。

响应示例 状态码： 200 查询会话列表响应成功。 { "session_types" : [ { "resource_spec_code" : "workspace.appstreamsession.premium", "session_type" : "GPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" }, { "resource_spec_code" : "workspace.appstreamsession.standard", "session_type" : "CPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" } ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 session_types Array of SessionTypeEntity objects 会话列表。 表4 SessionTypeEntity 参数 参数类型 描述 resource_spec_code String 资源规格编码。 session_type String 会话类型。 resource_type String 资源类型字段。 cloud_service_type 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 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 nat_gateways Array of NatGateway objects 网关实例信息列表。 表5 NatGateway 参数 参数类型 描述 id String 网关实例的ID。 tenant_id String 项目的ID。 name String 公网NAT网关实例的名字，长度限制为64。 description String 公网NAT网关实例的描述，长度限制为255。 spec String 公网NAT网关的规格。取值为：“1”：小型，SNAT最大连接数10000；“2”：中型，SNAT最大连接数50000；“3”：大型，SNAT最大连接数200000；“4”：超大型，SNAT最大连接数1000000。 status String 公网NAT网关实例的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE INACTIVE admin_state_up String 公网NAT网关实例的名字，长度限制为64。 解冻/冻结状态。取值范围： "true"：解冻 "false"：冻结 created_at String 公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 router_id String VPC的id。 internal_network_id String 公网NAT网关下行口（DVR的下一跳）所属的network id。 enterprise_project_id String 企业项目ID。创建公网NAT网关实例时，关联的企业项目ID。 状态码： 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接口进行解密。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 校验结果。 { "nat_gateways" : [ { "id" : "string", "tenant_id" : "string", "name" : "string", "description" : "string。", "spec" : "string", "status" : "string", "admin_state_up" : "string", "created_at" : "string", "router_id" : "string", "internal_network_id" : "string", "enterprise_project_id" : "string" } ]}

URI GET /v2/{project_id}/nat-gateways 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 公网NAT网关实例的ID。 enterprise_project_id 否 String 企业项目ID。创建公网NAT网关实例时，关联的企业项目ID。 description 否 String 公网NAT网关实例的描述，长度限制为255。 created_at 否 String 公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 name 否 String 公网NAT网关实例的名字，长度限制为64。公网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文。 status 否 Array of strings 公网NAT网关实例的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE INACTIVE spec 否 Array of strings 公网NAT网关实例的规格。取值为： "1"：小型，SNAT最大连接数10000；"2"：中型，SNAT最大连接数50000；"3"：大型，SNAT最大连接数200000；"4"：超大型，SNAT最大连接数1000000。 router_id 否 String VPC的id。 limit 否 Integer 功能说明：每页返回的个数。取值范围：0~2000。默认值：2000。

URI GET /v2/{project_id}/statistics/metrics/trend 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间。 end_time 是 String 结束时间。 dim 否 String 指标维度 | 目前最大支持3个维度，必须从0开始；维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 单维度：dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 多维度：dim.0=key,value&dim.1=key,value。 metric_names 是 Array of strings 指标名称列表，支持的指标名称参考Workspace运维监控指标。 period 否 String 数据周期 | MIN - 分钟级 5MIN - 5分钟级 DAY - 天级数据 HOUR - 小时级数据。