华为云用户手册

  • 响应示例 状态码: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接口进行解密。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 id_list 否 Array of strings 绑定策略ID列表。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 items Array of AttachServerAppInfo objects 分发软件信息列表。 表4 AttachServerAppInfo 参数 参数类型 描述 id String 分发软件版本ID。 app_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 错误描述。
  • 响应参数 状态码: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 成功响应。 { "session_info_list" : [ { "id" : "a7db732e1ad511edaf56fa163ed8e03f", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-1358-zeng**long@wksapp.****huawei.com-HDP-_1", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "1", "pre_conn_time" : "2022-08-13 07:00:20", "start_time" : "2022-08-13 07:00:20", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-**4560728-768171367-1358", "session_state" : "AppcInit", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.**.**.239", "client_version" : "22.4.2.12888", "client_type" : "Windows 10 Enterprise", "agent_version" : "21.12.0.11461", "vm_ip" : "172.**.**.26", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" }, { "id" : "9d123d5e0f36419c9b345efcd031a92e", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3006-zeng**long@wksapp.****huawei.com-HDP-2", "os_session_id" : "2", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "2", "app_group_id" : "587004825166675968", "app_server_group_id" : "fb8a92be-ebc1-4dac-9a4c-1590518d140a", "pre_conn_time" : "2023-07-07 03:04:06", "start_time" : "2023-07-07 03:04:06", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-***560728-768171367-3006", "machine_name" : "APS-6NGU98Y4W4", "session_state" : "AppcInit", "app_name" : "HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.*.97.212", "client_version" : "23.2.2.0", "client_type" : "Windows 10 Enterprise", "agent_version" : "23.2.0.0314", "vm_ip" : "172.*.*.41", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" } ] }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 session_info_list Array of AppSession objects 会话信息列表。 表5 AppSession 参数 参数类型 描述 id String 主键ID。 session_stamp String 会话标识。 os_session_id String 会话在hda的os中会话id。 protocol_type String 协议类型。 login_user String 当前会话的登录用户。 session_type String 会话类型,1表示共享桌面,2表示应用。 app_group_id String App组ID。 app_server_group_id String AppServer组ID。 pre_conn_time String 预连接时间。 start_time String 会话开始时间。 end_time String 会话结束时间。 status_continue_time String 状态持续时间。 machine_sid String 服务器SID。。 machine_name String 服务器名称。 session_state String 会话状态。 app_name String 会话中的应用名称。 client_mac String 客户端Mac地址。 client_name String 客户端名称。 client_ip String 客户端IP。 public_ip String 客户端出口ip。 client_version String 客户端版本。 client_type String 客户端类型。 agent_version String agent版本。 vm_ip String 服务器IP。 failed_reason String 错误原因消息。 failed_code String 错误原因码。 last_update_status_time String 状态最后变化时间。 tenant_id String 租户ID。 状态码: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 错误描述。
  • 响应示例 状态码:200 成功响应。 { "enable" : true, "max_scaling_amount" : 10, "single_expansion_count" : 1, "scaling_policy_by_session" : { "session_usage_threshold" : 85, "shrink_after_session_idle_minutes" : 60 } }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用: 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表5 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码: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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 发送的实体的MIME类型,如:application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 用户组名称。 platform_type 是 String 用户组类型。 AD: AD域用户组 LOCAL: 本地liteAs用户组 description 否 String 用户组描述。
  • 响应参数 状态码:201 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: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接口进行解密。
  • 响应参数 状态码:200 表10 响应Body参数 参数 参数类型 描述 orders Array of OrderV5 objects 批量生成订单结果。 表11 OrderV5 参数 参数类型 描述 order_id String 订单id。 order_status Integer 订单状态:0:初始化; 1:待审核; 2:待退款; 3:处理中; 4:已取消; 5:已完成; 6:待支付; 7:补偿中; 8:待审批; 9:待确认; 10:待发货; 11:待收货; 12:待上门取货; 13:换新中; 14:待商家收货。 result String 结果,SUC CES S:成功; FAIL:失败。 result_code String result=FAIL时,必填,表示该订单失败原因。 result_msg String 失败信息,和result_code结对出现。 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:409 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 请求示例 { "type" : "string", "add_volume_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "volume_type" : "string", "volume_size" : 8200 }, "extend_volume_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "desktop_pool_disk_id" : "string", "new_size" : 8200 }, "resize_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "product_id" : "string", "mode" : "string", "extend_param" : { "is_auto_pay" : "string" } }, "change_image_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "image_spec_code" : "string", "image_id" : "string", "delay_time" : 15, "message" : "string" }, "add_sub_resources_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "sub_resource_sku" : "string" }, "delete_sub_resources_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "sub_resource_type" : "string" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 否 String 下单类型。 ADD_VOLUME:增加磁盘 EXTEND_VOLUME:扩容磁盘 RESIZE:变更规格 CHANGE_IMAGE:切换镜像 ADD_SUB_RESOURCES:购买桌面协同资源 DELETE_SUB_RESOURCES:退订桌面协同资源 add_volume_param 否 EstimateAddVolumeRequestBody object 包周期桌面池添加磁盘、切换镜像询价请求体。 extend_volume_param 否 EstimateExtendVolumeRequestBody object 包周期扩容磁盘询价请求体。 resize_param 否 CreateResizeOrderRequestBody object 包周期变更规格询价请求体。 change_image_param 否 CreateChangeImageOrderRequestBody object 包周期重建系统盘询价请求体。 add_sub_resources_param 否 EstimateAddSubResourcesRequestBody object 包周期新增附属资源询价请求体。 delete_sub_resources_param 否 CreateDeleteSubResourcesOrderRequestBody object 包周期删除附属资源询价请求体。 表4 EstimateAddVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 volume_type 是 String 新增磁盘类型。 volume_size 是 Integer 新增磁盘大小。 表5 EstimateExtendVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 desktop_pool_disk_id 是 String 需要扩容的桌面池磁盘ID。 new_size 是 Integer 扩容后的磁盘大小。 表6 CreateResizeOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 product_id 是 String 目标规格产品ID。 mode 否 String 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP,如果桌面处于开机状态,会先关机再变更规格。 表7 CreateChangeImageOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 image_spec_code 否 String 云市场镜像的specCode,即将停用。image_spec_code与image_id同时存在时取image_id的值,两者不可同时为空。 image_id 否 String 云市场镜像ID,建议使用image_id。 delay_time 否 Integer 立即重建时给用户预留的保存数据的时间(单位:分钟)。 message 否 String 下发重建系统盘任务时,给用户发送的提示信息。 表8 EstimateAddSubResourcesRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_sku 是 String 新增附属资源SKU码。 表9 CreateDeleteSubResourcesOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_type 是 String 待删除附属资源类型:DESKTOP_SHARER(桌面协同资源)。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 password String 密码。 状态码: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接口进行解密。
  • URI GET /v2/{project_id}/users/{user_id}/random-password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 user_id 是 String 用户ID。 表2 Query参数 参数 是否必选 参数类型 描述 notification_type 否 String 通知用户类型,现在有“email”和“phone”两种,用","分开,用户为用户激活模式时必须要带上通知类型,以便接收到密码通知。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 project_id String 租户ID 同tenant_id。 service_status String 企业是否激活:active(激活),inactive(未激活)。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应参数 状态码:200 表8 响应Body参数 参数 参数类型 描述 job_id String 对于创建云应用服务器命令下发后会返回job_id,通过job_id可以查询任务的执行状态,按需购买返回该参数。 order_id String 订单号,创建包年包月的弹性云服务器时返回该参数。 状态码: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 错误描述。 状态码:500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 { "availability_zone" : "cn-north-5a", "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9", "nics" : [ { "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9" } ], "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "c3.large.4", "os_type" : "Windows", "root_volume" : { "type" : "SAS", "size" : 80 }, "server_group_id" : "f309fa65-881a-4f49-8c06-31e20437ae20", "vpc_id" : "d987ecf7-c6a4-4753-8b66-135dcc3eed79", "ou_name" : "", "update_access_agent" : false, "type" : "createApps", "subscription_num" : 1, "create_server_extend_param" : { "charging_mode" : "prePaid", "period_type" : 3, "period_num" : 2, "is_auto_renew" : false, "is_auto_pay" : false } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 创建云服务类型,当前仅支持创建云应用:createApps。 server_group_id 是 String 服务器组唯一标识。 availability_zone 否 String 可用分区。 说明: 将服务创建到指定的可用分区,如果不指定则使用系统随机的可用分区。 获取方式详见可用区管理ListAvailabilityZone:"GET /v1/{project_id}/availability-zone"。 subscription_num 是 Integer 订购数量。 nics 否 Array of Nic objects 服务对应的网卡信息,当前未使用该字段。 ou_name 否 String OU名称,在对接AD时使用,需提前在AD中创建OU。 product_id 是 String 产品ID。 说明: 获取方式详见产品套餐管理ListProduct:"GET /v1/{project_id}/product"。 flavor_id 否 String 规格ID。 os_type 否 String 操作系统类型,当前仅支持Windows。 root_volume 是 Volume object 系统盘: 磁盘容量,磁盘容量最大只支持1024G, 且为10的倍数。 scheduler_hints 否 WdhParam object 专属主机: 专属主机只支持按需模式,包周期模式不支持专属主机。 subnet_id 是 String 网卡对应的子网ID。 vpc_id 是 String 虚拟私有云ID。 update_access_agent 否 Boolean 是否自动升级hda版本。 create_server_extend_param 否 CreateServerExtendParam object 创建云服务器附加信息。 表4 Nic 参数 是否必选 参数类型 描述 ip_address 否 String IP地址。 subnet_id 否 String 网卡对应的子网ID。 表5 Volume 参数 是否必选 参数类型 描述 type 是 String 磁盘类型,获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO size 是 Integer 磁盘容量,单位GB,数值约束为10的倍数。 系统盘 minLength: 10,maxLength: 1024 数据盘 minLength: 10,maxLength: 32768 cluster_id 否 String 云服务器系统盘对应的存储池的ID。 表6 WdhParam 参数 是否必选 参数类型 描述 dedicated_host_id 否 String 云办公主机id。 tenancy 否 String 专属主机类型,目前只支持dedicated。 - dedicated:专属型 - shared: 共享型。 表7 CreateServerExtendParam 参数 是否必选 参数类型 描述 charging_mode 否 String 计费模式,取值范围: prePaid-预付费,即包年包月; postPaid-后付费,即按需付费; period_type 否 Integer 周期类型 2:包月;3:包年* chargingMode为prePaid时生效且为必选值。 period_num 否 Integer 订购周期数,chargingMode为prePaid时生效且为必选值,periodNum为正整数,取值范围: 说明: periodType=2(周期类型为月)时,取值为[1,9]。 periodType=3(周期类型为年)时,取值为[1,3]。 is_auto_renew 否 Boolean 是否是自动续订,默认不填为false。 说明: false 不自动续订。 true 自动续订。 is_auto_pay 否 Boolean 下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。chargingMode为prePaid时生效,不传该字段时默认为客户手动支付。 说明: true :是(自动支付)。 false:否(需要客户手动支付)。
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用: 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表6 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码: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 错误描述。 状态码:500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 { "enable" : true, "max_scaling_amount" : 10, "single_expansion_count" : 1, "scaling_policy_by_session" : { "session_usage_threshold" : 85, "shrink_after_session_idle_minutes" : 60 }, "server_group_id" : "1c873056-9f4d-11ec-b909-0242ac120002" }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全